Package gda.px.humiditycontroller

Class HC1EpicsDummyDevice

java.lang.Object
gda.factory.ConfigurableBase
gda.factory.FindableConfigurableBase
gda.px.humiditycontroller.HC1DeviceBase
gda.px.humiditycontroller.HC1EpicsDummyDevice
All Implemented Interfaces:
Configurable, Findable, gda.observable.IObservable, HC1Device
@ServiceInterface(HC1Device.class) public class HC1EpicsDummyDevice extends HC1DeviceBase implements Configurable
Mirror the HC1Device in terms of class structure PROPER COMMENTS HERE bean configuration found at: gda-mx.git.configurations.mx-config.servers.live humidity_controller.xml File imported in the common.xml or server.xml for a given beamline RMI client/server definition: gda-mx.git/configurations/mx-config/servers humidity_controller.xml

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    basePv
     
    boolean
    hc1_configure
     

    Fields inherited from class gda.px.humiditycontroller.HC1DeviceBase

    oc

  • Constructor Summary

    Constructors
    Constructor
    Description
    HC1EpicsDummyDevice()
     

  • 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.
    String
    getBasePv()
     
    Rectangle
    getDropCoords()
    Get the coordinates of the max and min point of a drop
    double
    getDropSize()
    Get the change in size of the drop when compared against some initial calculation of the drop size, expressed as a % increase or decrease in the relative drop size - depends on whether drop size tracking has been activated
    boolean
    getDropSizeTracking()
    Get the flag that indicates whether drop size tracking is activate/deactivated - mappings are {1.0 -> True,0.0 -> False}
    double
    getRH()
    Gets the Relative Humidity of the device as a %.
    double
    getRHSetPoint()
    Gets the set point for the Relative Humidity of the Device as a %
    Rectangle
    getROI()
    Get the coordinates of the rectangular area that frames the Region of Interest of a Drop on the image
    double
    getSampleTemp()
    Gets the sample temperature of the Device in degrees Celsius
    boolean
    isConfigureAtStartup()
    Indicates whether this object should be configured at startup.
    void
    reconfigure()
    Re-initialisation of values and states.
    void
    setBasePv(String basePv)
    Bean required method to set the stem of the HC1 PV string to match currently running beamline
    void
    setDropSize()
    Reset the drop size to 100% - the current drop size calculation becomes the reference value
    void
    setDropSizeTracking(boolean trackDrop)
    Set the flag to activate/deactivate drop size tracking - mappings are {true -> Activate (1.0), false -> Deactivate (0.0)}
    void
    setRHSetPoint(double setPoint)
    Sets the set point for the Relative Humidity of the Device as a %.
    void
    setROI(int x, int y, int width, int height)
    Sets the coordinates that frames the Region of Interest of the Drop on the image using the explicit (x,y) coordinates of the bottom corner of rectangle, and its height and width
    void
    setROI(Rectangle roi)
    Sets the coordinates that frames the Region of Interest of the Drop on the image using the Rectangular class

    Methods inherited from class gda.px.humiditycontroller.HC1DeviceBase

    addIObserver, deleteIObserver, deleteIObservers, help

    Methods inherited from class gda.factory.FindableConfigurableBase

    getName, setName

    Methods inherited from class gda.factory.ConfigurableBase

    isConfigured, setConfigured

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface gda.factory.Configurable

    isConfigured

    Methods inherited from interface gda.factory.Findable

    getName, setName

  • Field Details

    • hc1_configure

      public boolean hc1_configure

    • basePv

      protected String basePv

  • Constructor Details

    • HC1EpicsDummyDevice

      public HC1EpicsDummyDevice()

  • Method Details

    • getRH

      public double getRH() throws DeviceException
      Description copied from interface: HC1Device
      Gets the Relative Humidity of the device as a %.
      Specified by:
      getRH in interface HC1Device
      Returns:
      Relative Humidity as a %
      Throws:
      DeviceException

    • getRHSetPoint

      public double getRHSetPoint() throws DeviceException
      Description copied from interface: HC1Device
      Gets the set point for the Relative Humidity of the Device as a %
      Specified by:
      getRHSetPoint in interface HC1Device
      Returns:
      Relative Humidity Set Point %
      Throws:
      DeviceException

    • setRHSetPoint

      public void setRHSetPoint(double setPoint) throws DeviceException
      Description copied from interface: HC1Device
      Sets the set point for the Relative Humidity of the Device as a %.
      Specified by:
      setRHSetPoint in interface HC1Device
      Parameters:
      setPoint - - Relative Humidity Set Point as a %
      Throws:
      DeviceException

    • getSampleTemp

      public double getSampleTemp() throws DeviceException
      Description copied from interface: HC1Device
      Gets the sample temperature of the Device in degrees Celsius
      Specified by:
      getSampleTemp in interface HC1Device
      Returns:
      Internal device temperature in Celsius %
      Throws:
      DeviceException

    • getROI

      public Rectangle getROI() throws DeviceException
      Description copied from interface: HC1Device
      Get the coordinates of the rectangular area that frames the Region of Interest of a Drop on the image
      Specified by:
      getROI in interface HC1Device
      Returns:
      Coordinates of the Rectangle of a Region of Interest from an image
      Throws:
      DeviceException

    • setROI

      public void setROI(Rectangle roi) throws DeviceException
      Description copied from interface: HC1Device
      Sets the coordinates that frames the Region of Interest of the Drop on the image using the Rectangular class
      Specified by:
      setROI in interface HC1Device
      Throws:
      DeviceException

    • setROI

      public void setROI(int x, int y, int width, int height) throws DeviceException
      Description copied from interface: HC1Device
      Sets the coordinates that frames the Region of Interest of the Drop on the image using the explicit (x,y) coordinates of the bottom corner of rectangle, and its height and width
      Specified by:
      setROI in interface HC1Device
      Throws:
      DeviceException

    • getDropSize

      public double getDropSize() throws DeviceException
      Description copied from interface: HC1Device
      Get the change in size of the drop when compared against some initial calculation of the drop size, expressed as a % increase or decrease in the relative drop size - depends on whether drop size tracking has been activated
      Specified by:
      getDropSize in interface HC1Device
      Returns:
      Change in drop size as a percentage change
      Throws:
      DeviceException

    • setDropSize

      public void setDropSize() throws DeviceException
      Description copied from interface: HC1Device
      Reset the drop size to 100% - the current drop size calculation becomes the reference value
      Specified by:
      setDropSize in interface HC1Device
      Throws:
      DeviceException

    • getDropCoords

      public Rectangle getDropCoords() throws DeviceException
      Description copied from interface: HC1Device
      Get the coordinates of the max and min point of a drop
      Specified by:
      getDropCoords in interface HC1Device
      Returns:
      Coordinates that represent the max and min of a drop
      Throws:
      DeviceException

    • getDropSizeTracking

      public boolean getDropSizeTracking() throws DeviceException
      Description copied from interface: HC1Device
      Get the flag that indicates whether drop size tracking is activate/deactivated - mappings are {1.0 -> True,0.0 -> False}
      Specified by:
      getDropSizeTracking in interface HC1Device
      Returns:
      Flag that indicates if Drop Size Tracking is Activated/Deactivated
      Throws:
      DeviceException

    • setDropSizeTracking

      public void setDropSizeTracking(boolean trackDrop) throws DeviceException
      Description copied from interface: HC1Device
      Set the flag to activate/deactivate drop size tracking - mappings are {true -> Activate (1.0), false -> Deactivate (0.0)}
      Specified by:
      setDropSizeTracking in interface HC1Device
      Throws:
      DeviceException

    • setBasePv

      public void setBasePv(String basePv)
      Bean required method to set the stem of the HC1 PV string to match currently running beamline

    • getBasePv

      public String getBasePv()

    • 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
      Overrides:
      reconfigure in class ConfigurableBase
      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
      Overrides:
      isConfigureAtStartup in class ConfigurableBase

    • 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