Package gda.px.humiditycontroller

Interface HC1Device

All Superinterfaces:
Configurable, Findable, gda.observable.IObservable
All Known Implementing Classes:
HC1DeviceBase, HC1EpicsDevice, HC1EpicsDummyDevice
public interface HC1Device extends Findable, gda.observable.IObservable, Configurable
Interface Class of the set of services available to a user from the Jython Command line to control the HC1 device

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    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 interface gda.factory.Configurable

    configure, isConfigureAtStartup, isConfigured, reconfigure

    Methods inherited from interface gda.factory.Findable

    getName, setName

    Methods inherited from interface gda.observable.IObservable

    addIObserver, deleteIObserver, deleteIObservers

  • Method Details

    • getRH

      double getRH() throws DeviceException
      Gets the Relative Humidity of the device as a %.
      Returns:
      Relative Humidity as a %
      Throws:
      DeviceException

    • getRHSetPoint

      double getRHSetPoint() throws DeviceException
      Gets the set point for the Relative Humidity of the Device as a %
      Returns:
      Relative Humidity Set Point %
      Throws:
      DeviceException

    • setRHSetPoint

      void setRHSetPoint(double setPoint) throws DeviceException
      Sets the set point for the Relative Humidity of the Device as a %.
      Parameters:
      setPoint - - Relative Humidity Set Point as a %
      Throws:
      DeviceException

    • getSampleTemp

      double getSampleTemp() throws DeviceException
      Gets the sample temperature of the Device in degrees Celsius
      Returns:
      Internal device temperature in Celsius %
      Throws:
      DeviceException

    • getROI

      Rectangle getROI() throws DeviceException
      Get the coordinates of the rectangular area that frames the Region of Interest of a Drop on the image
      Returns:
      Coordinates of the Rectangle of a Region of Interest from an image
      Throws:
      DeviceException

    • setROI

      void setROI(Rectangle roi) throws DeviceException
      Sets the coordinates that frames the Region of Interest of the Drop on the image using the Rectangular class
      Throws:
      DeviceException

    • setROI

      void setROI(int x, int y, int width, int height) throws DeviceException
      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
      Throws:
      DeviceException

    • getDropSize

      double getDropSize() throws DeviceException
      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
      Returns:
      Change in drop size as a percentage change
      Throws:
      DeviceException

    • setDropSize

      void setDropSize() throws DeviceException
      Reset the drop size to 100% - the current drop size calculation becomes the reference value
      Throws:
      DeviceException

    • getDropCoords

      Rectangle getDropCoords() throws DeviceException
      Get the coordinates of the max and min point of a drop
      Returns:
      Coordinates that represent the max and min of a drop
      Throws:
      DeviceException

    • getDropSizeTracking

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

    • setDropSizeTracking

      void setDropSizeTracking(boolean trackDrop) throws DeviceException
      Set the flag to activate/deactivate drop size tracking - mappings are {true -> Activate (1.0), false -> Deactivate (0.0)}
      Throws:
      DeviceException