Interface CustomVariable

  • All Superinterfaces:
    MadxVariable, TwissVariable, Variable
    All Known Implementing Classes:
    CustomVariableImpl

    public interface CustomVariable
    extends TwissVariable
    This is the interface of a variable. It represents a madx definition of a key-value pair. A Variable may be e.g. parsed from a strength file and then plotted in a gui. For the moment the expression of a variable can not be explicitely set and the name can not be changed.
    • Method Detail

      • getExpression

        java.lang.String getExpression()
        retrieve the expression of the variable. (The string which is used to calculate the variable within madx)
        Returns:
        the expression as string
      • getComment

        java.lang.String getComment()
        The comment for this variable. It is retrieved from the comment string in the same line as the variable definition. (If there is one)
        Returns:
        a comment concerning this variable
      • isLateAssigned

        boolean isLateAssigned()
        Returns:
        true if the variable is defined by ":=", false if it is defined with "=".
      • getKey

        java.lang.String getKey()
        Returns:
        a unified key