Package gda.beamline

Interface BeamlineInfo

All Superinterfaces:
Findable, gda.observable.IObservable, Serializable
All Known Implementing Classes:
Beamline
public interface BeamlineInfo extends Findable, gda.observable.IObservable, Serializable
access methods for users to enquire current values about the beamline which are used in data collection. This object is accessible over CORBA so that GUI objects have access to the same data. This interface extends IObservable so that GUI objects can be informed of any changes made.

  • Method Details

    • getDataDir

      String getDataDir()
      gets the current data directory
      Returns:
      path to current data directory

    • setDataDir

      void setDataDir(String dataDir)
      sets or changes the current data directory to the value specified. It provides a way to change gda output data directory after GDA has started.
      Parameters:
      dataDir -

    • getFilePrefix

      String getFilePrefix()
      gets the prefix for the data file name.
      Returns:
      file prefix

    • setFilePrefix

      void setFilePrefix(String filePrefix)
      sets or changes the prefix for the data file name to the specified value.
      Parameters:
      filePrefix -

    • getFileSuffix

      String getFileSuffix()
      gets the suffix for the data file name
      Returns:
      file suffix

    • setFileSuffix

      void setFileSuffix(String fileSuffix)
      sets or changes the suffix for data file name to the specified value.
      Parameters:
      fileSuffix -

    • getFileExtension

      String getFileExtension()
      gets the extension name for the data file name
      Returns:
      file extension

    • setFileExtension

      void setFileExtension(String fileExtension)
      sets or change the extension name to the specified value for data file name.
      Parameters:
      fileExtension -

    • getFileNumber

      int getFileNumber()
      returns current file number
      Returns:
      the current file number

    • getNextFileNumber

      int getNextFileNumber()
      returns the next file number. This causes the NumTracker to increment the file number for the system.
      Returns:
      the next file number

    • getProjectName

      String getProjectName()
      gets the extension name for the data file name
      Returns:
      file extension

    • setProjectName

      void setProjectName(String project)
      sets or change the extension name to the specified value for data file name.
      Parameters:
      project -

    • getExperimentName

      String getExperimentName()
      gets the extension name for the data file name
      Returns:
      file extension

    • setExperimentName

      void setExperimentName(String experiment)
      sets or change the extension name to the specified value for data file name.
      Parameters:
      experiment -

    • getHeader

      String getHeader()
      gets the header string for this beamline
      Returns:
      header

    • setHeader

      void setHeader(String header)
      sets the header string for this beamline
      Parameters:
      header -

    • getSubHeader

      String getSubHeader()
      gets the sub-header string for the beamline
      Returns:
      sub-header

    • setSubHeader

      void setSubHeader(String subHeader)
      sets the sub-header string for the beamline
      Parameters:
      subHeader -