Package cern.accsoft.steering.jmad.domain.result.tfs

Interface TfsSummary

  • All Known Implementing Classes:
    TfsSummaryImpl
    public interface TfsSummary
    An implementation of this interface shall contain all the information which is available in the Twiss-summary of madx. i.e. in the header of a tfs-file.

    In general the values in here are a representation of the values of the summary table of MadX.

    • Method Detail

      • getDoubleValue

        java.lang.Double getDoubleValue​(java.lang.String key)
        Retrieve one of the Twiss Summary Values...

        NOTE: Avoid this access. Better use getDoubleValue(GlobalVariable).

        Parameters:
        key - the name of the summary value to get
        Returns:
        the value of this global parameter
        See Also:
        getDoubleValue(GlobalVariable)

      • getDoubleValue

        java.lang.Double getDoubleValue​(GlobalVariable variable)
        retrieve a double value for the given global variable.

        This is the preferred way to access the data for double values!

        Parameters:
        variable - the variable for which to get the value
        Returns:
        the value

      • getStringValue

        java.lang.String getStringValue​(java.lang.String key)
        Retrieves the String representation of the data for the given key.

        NOTE: avoid this kind of data access! Use getStringValue(GlobalVariable) instead whenever possible!

        Parameters:
        key - the key for which to get the data
        Returns:
        the data as String
        See Also:
        getStringValue(GlobalVariable)

      • getStringValue

        java.lang.String getStringValue​(GlobalVariable variable)
        Retrieves the String representation of the data for the given variable.

        This is the preferred way to access String data in the summary.

        Parameters:
        variable - the variable for which to get the string representation of the value.
        Returns:
        the String representation of the data

      • getKeys

        java.util.Collection<java.lang.String> getKeys()
        Returns:
        all the keys for which there exist values in this summary

      • getVarType

        MadxVarType getVarType​(java.lang.String key)
        the type of the value for the given key
        Parameters:
        key - the key for which to query the type
        Returns:
        the type for the key

      • getVarType

        MadxVarType getVarType​(GlobalVariable variable)
        the type for the variable in this summary.
        Parameters:
        variable - the variable for which to get the type
        Returns:
        the type for the variable