Package csw.params.events

Class OpticalDetectorEvent

java.lang.Object

csw.params.events.OpticalDetectorEvent

public class OpticalDetectorEvent
extends java.lang.Object

The optical science detector system Observe Events

Constructor Summary

Constructors

Constructor	Description
OpticalDetectorEvent()

Method Summary

Modifier and Type	Method	Description
static ObserveEvent	create(Prefix sourcePrefix, ExposureId exposureId, EventName eventName)
static ObserveEvent	create(Prefix sourcePrefix, ExposureId exposureId, EventName eventName, java.lang.String filename)
static ObserveEvent	dataWriteEnd(Prefix sourcePrefix, ExposureId exposureId, java.lang.String filename)
static ObserveEvent	dataWriteStart(Prefix sourcePrefix, ExposureId exposureId, java.lang.String filename)
static ObserveEvent	exposureAborted(Prefix sourcePrefix, ExposureId exposureId)
static ObserveEvent	exposureData(Prefix sourcePrefix, ExposureId exposureId, long exposureTime, long remainingExposureTime)	This event contains faster changing data about the internals of the current exposure.
static ObserveEvent	exposureEnd(Prefix sourcePrefix, ExposureId exposureId)
static ObserveEvent	exposureStart(Prefix sourcePrefix, ExposureId exposureId)
static ObserveEvent	exposureState(Prefix sourcePrefix, ExposureId exposureId, boolean exposureInProgress, boolean abortInProgress, boolean isAborted, java.lang.String errorMessage, OperationalState operationalState)
static ObserveEvent	observeEnd(Prefix sourcePrefix)
static ObserveEvent	observeEnd(Prefix sourcePrefix, ObsId obsId)
static ObserveEvent	observeStart(Prefix sourcePrefix)
static ObserveEvent	observeStart(Prefix sourcePrefix, ObsId obsId)
static ObserveEvent	prepareStart(Prefix sourcePrefix, ExposureId exposureId)
static ObserveEvent	readoutEnd(Prefix sourcePrefix, ExposureId exposureId)
static ObserveEvent	readoutFailed(Prefix sourcePrefix, ExposureId exposureId)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpticalDetectorEvent

public OpticalDetectorEvent()

Method Detail

prepareStart

public static ObserveEvent prepareStart(Prefix sourcePrefix,
                                        ExposureId exposureId)

exposureData

public static ObserveEvent exposureData(Prefix sourcePrefix,
                                        ExposureId exposureId,
                                        long exposureTime,
                                        long remainingExposureTime)

This event contains faster changing data about the internals of the current exposure. This data is useful for user interfaces and Sequencers. This event should be published at 1 Hz during an ongoing exposure. This event does not have much information compared to the IR use case and is primarily for tracking the remaining current exposure time in user interfaces or sequencers.

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.

exposureTime - Length in seconds of the current exposure

remainingExposureTime - Number of seconds remaining in current exposure • Should count down in seconds – no faster than 1 Hz

Returns:

ObserveEvent]

observeStart

public static ObserveEvent observeStart(Prefix sourcePrefix,
                                        ObsId obsId)

observeStart

public static ObserveEvent observeStart(Prefix sourcePrefix)

observeEnd

public static ObserveEvent observeEnd(Prefix sourcePrefix,
                                      ObsId obsId)

observeEnd

public static ObserveEvent observeEnd(Prefix sourcePrefix)

exposureStart

public static ObserveEvent exposureStart(Prefix sourcePrefix,
                                         ExposureId exposureId)

exposureEnd

public static ObserveEvent exposureEnd(Prefix sourcePrefix,
                                       ExposureId exposureId)

readoutEnd

public static ObserveEvent readoutEnd(Prefix sourcePrefix,
                                      ExposureId exposureId)

readoutFailed

public static ObserveEvent readoutFailed(Prefix sourcePrefix,
                                         ExposureId exposureId)

dataWriteStart

public static ObserveEvent dataWriteStart(Prefix sourcePrefix,
                                          ExposureId exposureId,
                                          java.lang.String filename)

dataWriteEnd

public static ObserveEvent dataWriteEnd(Prefix sourcePrefix,
                                        ExposureId exposureId,
                                        java.lang.String filename)

exposureAborted

public static ObserveEvent exposureAborted(Prefix sourcePrefix,
                                           ExposureId exposureId)

exposureState

public static ObserveEvent exposureState(Prefix sourcePrefix,
                                         ExposureId exposureId,
                                         boolean exposureInProgress,
                                         boolean abortInProgress,
                                         boolean isAborted,
                                         java.lang.String errorMessage,
                                         OperationalState operationalState)

create

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

create

public static ObserveEvent create(Prefix sourcePrefix,
                                  ExposureId exposureId,
                                  EventName eventName,
                                  java.lang.String filename)