Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package params

    This project is intended to hold reusable models and params used throughout the csw source code.

    Params

    This project is intended to hold reusable models and params used throughout the csw source code.

    This also provides out of the box support to cater to the diverse communication requirements. Consumer of this library will be able to create Commands, Events, States to store ParameterSets.

    Imp Packages

    Commands and Events

    This packages contains classes, traits and models used to create *commands* and *events*. These are all based on type-safe keys and items (a set of values with optional units). Each key has a specific type and the key's values must be of that type.

    Two types of csw.params.commands.Command are supported:

    Following are the concrete commands supported by csw:

    Two types of csw.params.events.Event are supported:

    core

    This package supports serialization and deserialization of commands, events and state variables in JSON format csw.params.core.formats.JsonSupport.

    Scala and Java APIs

    All the param and event classes are immutable. The set methods return a new instance of the object with a new item added and the get methods return an Option, in case the Key is not found. There are also value methods that return a value directly, throwing an exception if the key or value is not found.

    Key Types

    A set of standard key types and matching items are defined. Each key accepts one or more values of the given type.

    Following csw.params.core.generics.KeyType are supported by csw:

    +--------------+-------------------------+---------------------------+
|  Primitive   |      Scala KeyType      |       Java KeyType        |
+--------------+-------------------------+---------------------------+
| Boolean      | KeyType.BooleanKey      | JKeyType.BooleanKey      |
| Character    | KeyType.CharKey         | JKeyType.JCharKey        |
| Byte         | KeyType.ByteKey         | JKeyType.ByteKey         |
| Short        | KeyType.ShortKey        | JKeyType.ShortKey        |
| Long         | KeyType.LongKey         | JKeyType.LongKey         |
| Int          | KeyType.IntKey          | JKeyType.IntKey          |
| Float        | KeyType.FloatKey        | JKeyType.FloatKey        |
| Double       | KeyType.DoubleKey       | JKeyType.DoubleKey       |
| String       | KeyType.StringKey       | JKeyType.StringKey       |
| UtcTime      | KeyType.UTCTimeKey      | JKeyType.UTCTimeKey      |
| TaiTime      | KeyType.TAITimeKey      | JKeyType.TAITimeKey      |
| ----------   | ----------              | ----------               |
| ByteArray    | KeyType.ByteArrayKey    | JKeyType.ByteArrayKey    |
| ShortArray   | KeyType.ShortArrayKey   | JKeyType.ShortArrayKey   |
| LongArray    | KeyType.LongArrayKey    | JKeyType.LongArrayKey    |
| IntArray     | KeyType.IntArrayKey     | JKeyType.IntArrayKey     |
| FloatArray   | KeyType.FloatArrayKey   | JKeyType.FloatArrayKey   |
| DoubleArray  | KeyType.DoubleArrayKey  | JKeyType.DoubleArrayKey  |
| ----------   | ----------              | ----------               |
| ByteMatrix   | KeyType.ByteMatrixKey   | JKeyType.ByteMatrixKey   |
| ShortMatrix  | KeyType.ShortMatrixKey  | JKeyType.ShortMatrixKey  |
| LongMatrix   | KeyType.LongMatrixKey   | JKeyType.LongMatrixKey   |
| IntMatrix    | KeyType.IntMatrixKey    | JKeyType.IntMatrixKey    |
| FloatMatrix  | KeyType.FloatMatrixKey  | JKeyType.FloatMatrixKey  |
| DoubleMatrix | KeyType.DoubleMatrixKey | JKeyType.DoubleMatrixKey |
| ----------   | ----------              | ----------               |
| Choice       | KeyType.ChoiceKey       | JKeyType.ChoiceKey       |
+--------------+-------------------------+---------------------------+

    Detailed information about creating Keys and Parameters can be found here: https://tmtsoftware.github.io/csw/services/messages/keys-parameters.html

    Detailed information about creating commands can be found here: https://tmtsoftware.github.io/csw/services/messages/commands.html

    Detailed information about creating events can be found here: https://tmtsoftware.github.io/csw/services/messages/events.html

    Definition Classes
    csw
  • package events
    Definition Classes
    params
  • CoordinateSystem
  • DMSObserveEvent
  • Event
  • EventKey
  • EventName
  • IRDetectorEvent
  • ObserveEvent
  • ObserveEventKeys
  • ObserveEventNames
  • OperationalState
  • OpticalDetectorEvent
  • ParamFactories
  • SequencerObserveEvent
  • SystemEvent
  • WFSDetectorEvent
c

csw.params.events

SequencerObserveEvent

case class SequencerObserveEvent(prefix: Prefix) extends Product with Serializable

The events that indicate activities for each observation and the acquisition process.

prefix

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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SequencerObserveEvent
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SequencerObserveEvent(prefix: Prefix)

    prefix

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def dataWriteEnd(exposureId: ExposureId, filename: String): ObserveEvent

    This event indicates that the instrument has finished writing the exposure data file or transfer of exposure data to DMS.

    This event indicates that the instrument has finished writing the exposure data file or transfer of exposure data to DMS.

    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.

    filename

    java.lang.String the path of the file.

    returns

    csw.params.events.ObserveEvent

  7. def dataWriteStart(exposureId: ExposureId, filename: String): ObserveEvent

    This event indicates that the instrument has started writing the exposure data file or transfer of exposure data to DMS.

    This event indicates that the instrument has started writing the exposure data file or transfer of exposure data to DMS.

    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.

    filename

    java.lang.String the path of the file.

    returns

    csw.params.events.ObserveEvent

  8. def downtimeStart(obsId: ObsId, reasonForDowntime: String): ObserveEvent

    This event indicates that something has occurred that interrupts the normal observing workflow and time accounting.

    This event indicates that something has occurred that interrupts the normal observing workflow and time accounting. This event will have a hint (TBD) that indicates the cause of the downtime for statistics. Examples are: weather, equipment or other technical failure, etc. Downtime is ended by the start of an observation or exposure.

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    reasonForDowntime

    java.lang.String a hint that indicates the cause of the downtime for statistics.

    returns

    csw.params.events.ObserveEvent

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def exposureAborted(exposureId: ExposureId): ObserveEvent

    This event indicates that a request was made to abort the exposure and it has completed.

    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

    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.

    returns

    csw.params.events.ObserveEvent

  11. def exposureEnd(exposureId: ExposureId): ObserveEvent

    This event indicates the end of data acquisition that results in a file produced for DMS.

    This event indicates the end of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.

    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.

    returns

    csw.params.events.ObserveEvent

  12. def exposureStart(exposureId: ExposureId): ObserveEvent

    This event indicates the start of data acquisition that results in a file produced for DMS.

    This event indicates the start of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.

    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.

    returns

    csw.params.events.ObserveEvent

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def guidestarAcqEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of locking the telescope to the sky with guide and WFS targets

    This event indicates the end of locking the telescope to the sky with guide and WFS targets

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  15. def guidestarAcqStart(obsId: ObsId): ObserveEvent

    This event indicates the start of locking the telescope to the sky with guide and WFS targets

    This event indicates the start of locking the telescope to the sky with guide and WFS targets

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  16. def inputRequestEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of a request to the user for input

    This event indicates the end of a request to the user for input

    obsId

    csw.params.core.models.ObsId Representing a unique observation id

    returns

    csw.params.events.ObserveEvent

  17. def inputRequestStart(obsId: ObsId): ObserveEvent

    This event indicates the start of a request to the user for input

    This event indicates the start of a request to the user for input

    obsId

    csw.params.core.models.ObsId Representing a unique observation id

    returns

    csw.params.events.ObserveEvent

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. def observationEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of execution of actions related to an observation including acquisition and science data acquisition.

    This event indicates the end of execution of actions related to an observation including acquisition and science data acquisition.

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  23. def observationStart(obsId: ObsId): ObserveEvent

    This event indicates the start of execution of actions related to an observation including acquisition and science data acquisition.

    This event indicates the start of execution of actions related to an observation including acquisition and science data acquisition.

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  24. def observeEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of execution of actions related to an Observe command

    This event indicates the end of execution of actions related to an Observe command

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  25. def observePaused(): ObserveEvent

    This event indicates that a user has paused the current observation Sequence which will happen after the current step concludes

    This event indicates that a user has paused the current observation Sequence which will happen after the current step concludes

    returns

    csw.params.events.ObserveEvent

  26. def observeResumed(): ObserveEvent

    This event indicates that a user has resumed a paused observation Sequence.

    This event indicates that a user has resumed a paused observation Sequence.

    returns

    csw.params.events.ObserveEvent

  27. def observeStart(obsId: ObsId): ObserveEvent

    This event indicates the start of execution of actions related to an Observe command

    This event indicates the start of execution of actions related to an Observe command

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  28. def offsetEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of a telescope offset or dither

    This event indicates the end of a telescope offset or dither

    obsId

    csw.params.core.models.ObsId representing a unique observation id

    returns

    csw.params.events.ObserveEvent

  29. def offsetStart(obsId: ObsId, coordinateSystem: CoordinateSystem, p: Double, q: Double): ObserveEvent

    This event indicates the start of a telescope offset or dither

    This event indicates the start of a telescope offset or dither

    obsId

    csw.params.core.models.ObsId representing a unique observation id

    coordinateSystem

    CoordinateSystem Represents coordinate system

    p

    java.lang.Double Represents telescope's xCoordinate offset

    q

    java.lang.Double Represents telescope's yCoordinate offset

    returns

    csw.params.events.ObserveEvent

  30. val prefix: Prefix
  31. def prepareStart(exposureId: ExposureId): ObserveEvent

    This event indicates that the detector system is preparing to start an exposure.

    This event indicates that the detector system is preparing to start an exposure.

    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.

    returns

    csw.params.events.ObserveEvent

  32. def presetEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of the preset phase of acquisition

    This event indicates the end of the preset phase of acquisition

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  33. def presetStart(obsId: ObsId): ObserveEvent

    This event indicates the start of the preset phase of acquisition

    This event indicates the start of the preset phase of acquisition

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. def readoutEnd(exposureId: ExposureId): ObserveEvent

    This event indicates that a readout that is part of a ramp has completed.

    This event indicates that a readout that is part of a ramp has completed.

    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.

    returns

    csw.params.events.ObserveEvent

  36. def readoutFailed(exposureId: ExposureId): ObserveEvent

    This event indicates that a readout that is part of a ramp has failed indicating transfer failure or some other issue.

    This event indicates that a readout that is part of a ramp has failed indicating transfer failure or some other issue.

    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.

    returns

    csw.params.events.ObserveEvent

  37. def scitargetAcqEnd(obsId: ObsId): ObserveEvent

    This event indicates the end of acquisition phase where science target is centered as needed after guidestar locking

    This event indicates the end of acquisition phase where science target is centered as needed after guidestar locking

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  38. def scitargetAcqStart(obsId: ObsId): ObserveEvent

    This event indicates the start of acquisition phase where science target is peaked up as needed after guidestar locking

    This event indicates the start of acquisition phase where science target is peaked up as needed after guidestar locking

    obsId

    csw.params.core.models.ObsId Represents a unique observation id

    returns

    csw.params.events.ObserveEvent

  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped