Package cern.accsoft.steering.jmad.domain.var.enums

Enum PtcTwissVariable

    • Method Detail

      • values

        public static PtcTwissVariable[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (PtcTwissVariable c : PtcTwissVariable.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PtcTwissVariable valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getMadxName

        public java.lang.String getMadxName()
        Description copied from interface: MadxVariable
        retrieve the name of the variable. This must be a unique expression within the madx model.
        Specified by:
        getMadxName in interface MadxVariable
        Returns:
        the name of the variable.

      • fromMadxName

        public static final PtcTwissVariable fromMadxName​(java.lang.String madxName)
        Determine the correct Value of ResultVariable for a given tag.
        Parameters:
        madxName - the tag for which to get the VarType - Value.
        Returns:
        The VarType corresponding to the given tag.

      • allOfType

        public static final java.util.Set<PtcTwissVariable> allOfType​(MadxVarType type)
        returns a set of variables of a given type.
        Parameters:
        type - which variables to retrieve
        Returns:
        the variables.

      • isApertureVariable

        public boolean isApertureVariable()
        Specified by:
        isApertureVariable in interface TwissVariable
        Returns:
        true, if this variable shall be plotted as aperture (second line with minus-sign)

      • getUnit

        public java.lang.String getUnit()
        Specified by:
        getUnit in interface Variable
        Returns:
        a string, that represents the unit of the variable

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface Variable
        Returns:
        the name of the variable (can be arbitrary)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<PtcTwissVariable>

      • getValueClass

        public java.lang.Class<?> getValueClass()
        Description copied from interface: Variable
        the type of the values which this variable represents
        Specified by:
        getValueClass in interface Variable
        Returns:
        The class of the values