WFSDetectorEvent

csw.params.events.WFSDetectorEvent

Wavefront detector system Observe events

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def exposureState(sourcePrefix: Prefix, exposureId: ExposureId, exposureInProgress: Boolean, abortInProgress: Boolean, isAborted: Boolean, operationalState: OperationalState, errorMessage: String): ObserveEvent

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.

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.

Value parameters

abortInProgress

java.lang.Boolean indicates that an abort has been requested and is underway.

errorMessage

java.lang.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

exposureId

csw.params.core.models.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

java.lang.Boolean indicating if detector system is acquiring an exposure. Delimited by exposureStart and exposureEnd. exposureInProgress should be false if abortInProgress is true (TBD)

isAborted

java.lang.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

operationalState

csw.params.events.OperationalState indicating if the detector system is available and operational.

sourcePrefix

csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.

Attributes

Returns

csw.params.events.ObserveEvent

def publishFail(sourcePrefix: Prefix): ObserveEvent

This event indicates that a WFS or guider detector system has failed while publishing an image to VBDS.

This event indicates that a WFS or guider detector system has failed while publishing an image to VBDS.

Value parameters

sourcePrefix

csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.

Attributes

Returns

csw.params.events.ObserveEvent

def publishSuccess(sourcePrefix: Prefix): ObserveEvent

This event indicates the WFS or guider detector system has successfully published an image to VBDS.

This event indicates the WFS or guider detector system has successfully published an image to VBDS.

Value parameters

sourcePrefix

csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.

Attributes

Returns

csw.params.events.ObserveEvent