Package csw.params.events

Class DetectorEvent

java.lang.Object
csw.params.events.DetectorEvent
Direct Known Subclasses:
IRDetectorEvent$, OpticalDetectorEvent$
public class DetectorEvent extends Object

  • Constructor Details

    • DetectorEvent

      public DetectorEvent(EventName detectorExpStateName)

  • Method Details

    • create

      public ObserveEvent create(Prefix sourcePrefix, ExposureId exposureId, EventName eventName)

    • create

      public ObserveEvent create(Prefix sourcePrefix, ExposureId exposureId, EventName eventName, String filename)

    • dataWriteEnd

      public ObserveEvent dataWriteEnd(Prefix sourcePrefix, ExposureId exposureId, String filename)
      This event indicates that the instrument has finished writing the exposure data file or transfer of exposure data to DMS.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      filename - String the path of the file.
      Returns:
      ObserveEvent

    • dataWriteStart

      public ObserveEvent dataWriteStart(Prefix sourcePrefix, ExposureId exposureId, String filename)
      This event indicates that the instrument has started writing the exposure data file or transfer of exposure data to DMS.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      filename - String the path of the file.
      Returns:
      ObserveEvent

    • exposureAborted

      public ObserveEvent exposureAborted(Prefix sourcePrefix, ExposureId exposureId)
      This event indicates that a request was made to abort the exposure and it has completed. Normal data events should occur if data is recoverable. Abort should not fail
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      Returns:
      ObserveEvent

    • exposureEnd

      public ObserveEvent exposureEnd(Prefix sourcePrefix, ExposureId exposureId)
      This event indicates the end of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      Returns:
      ObserveEvent

    • exposureStart

      public ObserveEvent exposureStart(Prefix sourcePrefix, ExposureId exposureId)
      This event indicates the start of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      Returns:
      ObserveEvent

    • exposureState

      public ObserveEvent exposureState(Prefix sourcePrefix, ExposureId exposureId, boolean exposureInProgress, boolean abortInProgress, boolean isAborted, String errorMessage, OperationalState operationalState)
      A state variable to indicate the current state of the detector system. The Exposure State Event groups parameters that change relatively slowly, and this event should be published whenever any of its parameters changes.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      exposureInProgress - Boolean indicating if detector system is acquiring an exposure. Delimited by exposureStart and exposureEnd. exposureInProgress should be false if abortInProgress is true (TBD)
      abortInProgress - Boolean indicates that an abort has been requested and is underway.
      isAborted - Boolean Indicates that an abort has occurred and is completed. abortInProgress should be false when isAborted is true. isAborted should be set to false with the next exposure
      errorMessage - String An parameter that can be included when the detector system is in the ERROR operationalState. This value should be cleared and removed from the state when the operationalState returns to READY
      operationalState - OperationalState indicating if the detector system is available and operational.
      Returns:
      ObserveEvent

    • observeEnd

      public ObserveEvent observeEnd(Prefix sourcePrefix, ObsId obsId)
      This event indicates the end of execution of actions related to an Observe command.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • observeEnd

      public ObserveEvent observeEnd(Prefix sourcePrefix)
      This event indicates the end of execution of actions related to an Observe command.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      Returns:
      ObserveEvent

    • observeStart

      public ObserveEvent observeStart(Prefix sourcePrefix, ObsId obsId)
      This event indicates the start of execution of actions related to an Observe command.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • observeStart

      public ObserveEvent observeStart(Prefix sourcePrefix)
      This event indicates the start of execution of actions related to an Observe command.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      Returns:
      ObserveEvent

    • readoutEnd

      public ObserveEvent readoutEnd(Prefix sourcePrefix, ExposureId exposureId)
      This event indicates that a readout that is part of a ramp has completed.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      Returns:
      ObserveEvent

    • readoutFailed

      public ObserveEvent readoutFailed(Prefix sourcePrefix, ExposureId exposureId)
      This event indicates that a readout that is part of a ramp has failed indicating transfer failure or some other issue.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      Returns:
      ObserveEvent