Package gda.factory

Class ConfigurableBase

java.lang.Object
gda.factory.ConfigurableBase
All Implemented Interfaces:
Configurable
Direct Known Subclasses:
ActorSampleChangerControllerBase, AnalyserEntranceSlit, BaseEpicsDeviceController, BioSAXSProgressController, BlockedPositionsComponent, BufferSizeMonitorProvider, ContainerBase, ContainerTypeBase, DaqBase, DataServerClientConfig, DummyDataNode, DummyEigerAncillaryAcquisitionSettings, DummyEigerDataAcquisition, DummyEigerFan, DummyEigerMxSettings, DummyHdf5Advanced, DummyMetaListener, DummyNXDetector, DummyOavAwtVideoReceiver, DummyOdinDataStatus, DummyVideoReceiverBase, DummyXmapEpicsDevice, EigerAncillaryDataBase, EigerAreaDetectorBase, EigerAreaDetectorCamPluginBase, EigerDetectorImpl, EigerOdinBase, EpicsAreaDetectorFileSaveImpl, EPICSAreaDetectorImageImpl, EpicsAreaDetectorImpl, EpicsAreaDetectorROIElementImpl, EpicsAreaDetectorROIImpl, EpicsArmablePressureValve, EpicsBase, EpicsDataNode, EpicsEigerAncillaryAcquisitionSettings, EpicsEigerDataAcquisition, EpicsEigerFan, EpicsEigerMxSettings, EpicsHdf5Advanced, EpicsMetaListener, EpicsOdinDataStatus, EpicsPandaController, EpicsPressureCellController, EpicsPressureValve, FactoryBase, FindableConfigurableBase, HC1DropsizeCalcBase, Hdf5Base, I24SmarActStageController, IcatXMLCreator, MappingViewConfiguration, MotionJpegOverHttpReceiverBase, NcdEpicsEiger, OavAreaDetectorCamPluginBase, PiezoActuatorHandler, PpuDiskPv, RedirectableFileLogger, RmiProxyFactory, SamplePresentMonitorBase, SampleStoreStateProvider, ServerFileListener, SpecsPhoibosAnalyserStatus, SpecsPhoibosController, StageControl, SubmissionQueuePauser, TemperatureCoolHandler, TemperatureRampHandler, VGScientaController, VGScientaOverExposureProtector, Xspress2DAServerController, Xspress3CollectionStrategy
public abstract class ConfigurableBase extends Object implements Configurable
Class giving a default implementation of the functions in Configurable

A default implementation of configure() is provided for objects that do not require explicit configuration but which implement Configurable or (more often) an interface derived from Configurable, for example dummy devices which must implement the same interface as their live equivalents.

Since:
GDA 9.8

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigurableBase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure()
    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.
    boolean
    isConfigureAtStartup()
    Indicates whether this object should be configured at startup.
    boolean
    isConfigured()
    Checks to see if the object is already configured.
    void
    reconfigure()
    Re-initialisation of values and states.
    protected void
    setConfigured(boolean configured)
    Set the configured state of the object

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ConfigurableBase

      public ConfigurableBase()

  • Method Details

    • setConfigured

      protected void setConfigured(boolean configured)
      Set the configured state of the object

      Subclasses will typically call this function with parameter true at the end of their implementation of configure(), and with false when closing the connection to a device and/or when starting to reconfigure it.

      Parameters:
      configured - The configured state of the object (see comment above).

    • configure

      public void configure() throws FactoryException
      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
      Throws:
      FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

    • isConfigured

      public boolean isConfigured()
      Description copied from interface: Configurable
      Checks to see if the object is already configured.
      Specified by:
      isConfigured in interface Configurable
      Returns:
      return true if configured false otherwise

    • reconfigure

      public void reconfigure() throws FactoryException
      Description copied from interface: Configurable
      Re-initialisation of values and states.

      Moved from Reconfigurable which has been deleted

      Specified by:
      reconfigure in interface Configurable
      Throws:
      FactoryException

    • isConfigureAtStartup

      public boolean isConfigureAtStartup()
      Description copied from interface: Configurable
      Indicates whether this object should be configured at startup.

      Moved from ConditionallyConfigurable which has been deleted

      Specified by:
      isConfigureAtStartup in interface Configurable