Package gda.beamline.beamline

Class Beamline

java.lang.Object
gda.factory.ConfigurableBase
gda.factory.FindableConfigurableBase
gda.beamline.beamline.Beamline
All Implemented Interfaces:
BeamlineInfo, Configurable, Findable, gda.observable.IObservable, Serializable
public class Beamline extends FindableConfigurableBase implements BeamlineInfo
This class provides access methods for users to query or change beamline parameters used in data collection, such as current data directory, file prefix, etc.
See Also:

  • Constructor Details

    • Beamline

      public Beamline()
      constructor

  • Method Details

    • configure

      public void configure() throws FactoryException
      Description copied from class: ConfigurableBase
      Default implementation for classes that do not have to do any specific configuration.
      Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
      Specified by:
      configure in interface Configurable
      Overrides:
      configure in class ConfigurableBase
      Throws:
      FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

    • getDataDir

      public String getDataDir()
      Description copied from interface: BeamlineInfo
      gets the current data directory
      Specified by:
      getDataDir in interface BeamlineInfo
      Returns:
      path to current data directory

    • setDataDir

      public void setDataDir(String dataDir)
      Description copied from interface: BeamlineInfo
      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.
      Specified by:
      setDataDir in interface BeamlineInfo
      Parameters:
      dataDir -

    • getFilePrefix

      public String getFilePrefix()
      Description copied from interface: BeamlineInfo
      gets the prefix for the data file name.
      Specified by:
      getFilePrefix in interface BeamlineInfo
      Returns:
      file prefix

    • setFilePrefix

      public void setFilePrefix(String filePrefix)
      Description copied from interface: BeamlineInfo
      sets or changes the prefix for the data file name to the specified value.
      Specified by:
      setFilePrefix in interface BeamlineInfo
      Parameters:
      filePrefix -

    • getFileSuffix

      public String getFileSuffix()
      Description copied from interface: BeamlineInfo
      gets the suffix for the data file name
      Specified by:
      getFileSuffix in interface BeamlineInfo
      Returns:
      file suffix

    • setFileSuffix

      public void setFileSuffix(String fileSuffix)
      Description copied from interface: BeamlineInfo
      sets or changes the suffix for data file name to the specified value.
      Specified by:
      setFileSuffix in interface BeamlineInfo
      Parameters:
      fileSuffix -

    • getFileExtension

      public String getFileExtension()
      Description copied from interface: BeamlineInfo
      gets the extension name for the data file name
      Specified by:
      getFileExtension in interface BeamlineInfo
      Returns:
      file extension

    • setFileExtension

      public void setFileExtension(String fileExtension)
      Description copied from interface: BeamlineInfo
      sets or change the extension name to the specified value for data file name.
      Specified by:
      setFileExtension in interface BeamlineInfo
      Parameters:
      fileExtension -

    • getFileNumber

      public int getFileNumber()
      Description copied from interface: BeamlineInfo
      returns current file number
      Specified by:
      getFileNumber in interface BeamlineInfo
      Returns:
      the current file number

    • getNextFileNumber

      public int getNextFileNumber()
      Description copied from interface: BeamlineInfo
      returns the next file number. This causes the NumTracker to increment the file number for the system.
      Specified by:
      getNextFileNumber in interface BeamlineInfo
      Returns:
      the next file number

    • getProjectName

      public String getProjectName()
      Description copied from interface: BeamlineInfo
      gets the extension name for the data file name
      Specified by:
      getProjectName in interface BeamlineInfo
      Returns:
      file extension

    • setProjectName

      public void setProjectName(String project)
      Description copied from interface: BeamlineInfo
      sets or change the extension name to the specified value for data file name.
      Specified by:
      setProjectName in interface BeamlineInfo
      Parameters:
      project -

    • getExperimentName

      public String getExperimentName()
      Description copied from interface: BeamlineInfo
      gets the extension name for the data file name
      Specified by:
      getExperimentName in interface BeamlineInfo
      Returns:
      file extension

    • setExperimentName

      public void setExperimentName(String experiment)
      Description copied from interface: BeamlineInfo
      sets or change the extension name to the specified value for data file name.
      Specified by:
      setExperimentName in interface BeamlineInfo
      Parameters:
      experiment -

    • getHeader

      public String getHeader()
      Description copied from interface: BeamlineInfo
      gets the header string for this beamline
      Specified by:
      getHeader in interface BeamlineInfo
      Returns:
      header

    • setHeader

      public void setHeader(String header)
      Description copied from interface: BeamlineInfo
      sets the header string for this beamline
      Specified by:
      setHeader in interface BeamlineInfo
      Parameters:
      header -

    • getSubHeader

      public String getSubHeader()
      Description copied from interface: BeamlineInfo
      gets the sub-header string for the beamline
      Specified by:
      getSubHeader in interface BeamlineInfo
      Returns:
      sub-header

    • setSubHeader

      public void setSubHeader(String subHeader)
      Description copied from interface: BeamlineInfo
      sets the sub-header string for the beamline
      Specified by:
      setSubHeader in interface BeamlineInfo
      Parameters:
      subHeader -

    • isConfigureAtStartup

      public boolean isConfigureAtStartup()
      Check whether the configure method should be called when the server is instantiated.
      Specified by:
      isConfigureAtStartup in interface Configurable
      Overrides:
      isConfigureAtStartup in class ConfigurableBase
      Returns:
      true if configuration is required at startup.

    • setConfigureAtStartup

      public void setConfigureAtStartup(boolean configureAtStartup)
      Set a flag to inform the server whether the configure method should be called at startup.
      Parameters:
      configureAtStartup - true to configure at startup.

    • addIObserver

      public void addIObserver(gda.observable.IObserver anIObserver)
      Specified by:
      addIObserver in interface gda.observable.IObservable

    • deleteIObserver

      public void deleteIObserver(gda.observable.IObserver anIObserver)
      Specified by:
      deleteIObserver in interface gda.observable.IObservable

    • deleteIObservers

      public void deleteIObservers()
      Specified by:
      deleteIObservers in interface gda.observable.IObservable