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

object OperationalState extends Enum[OperationalState]

Enumeration indicating if the detector system is available and operational. READY, BUSY, ERROR. READY indicates system can execute exposures. BUSY indicates system is BUSY most likely acquiring data. ERROR indicates the detector system is in an error state. This could happen as a result of a command or a spontaneous failure. Corrective action is required.

Linear Supertypes
Enum[OperationalState], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OperationalState
  2. Enum
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def extraNamesToValuesMap: Map[String, OperationalState]
    Definition Classes
    Enum
  9. macro def findValues: IndexedSeq[OperationalState]
    Attributes
    protected
    Definition Classes
    Enum
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def indexOf(member: OperationalState): Int
    Definition Classes
    Enum
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final lazy val lowerCaseNamesToValuesMap: Map[String, OperationalState]
    Definition Classes
    Enum
  15. lazy val namesToValuesMap: Map[String, OperationalState]
    Definition Classes
    Enum
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toChoices: Seq[Choice]
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final lazy val upperCaseNameValuesToMap: Map[String, OperationalState]
    Definition Classes
    Enum
  23. def values: IndexedSeq[OperationalState]
    Definition Classes
    OperationalState → Enum
  24. final lazy val valuesToIndex: Map[OperationalState, Int]
    Definition Classes
    Enum
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. def withName(name: String): OperationalState
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  29. def withNameEither(name: String): Either[NoSuchMember[OperationalState], OperationalState]
    Definition Classes
    Enum
  30. def withNameInsensitive(name: String): OperationalState
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  31. def withNameInsensitiveEither(name: String): Either[NoSuchMember[OperationalState], OperationalState]
    Definition Classes
    Enum
  32. def withNameInsensitiveOption(name: String): Option[OperationalState]
    Definition Classes
    Enum
  33. def withNameLowercaseOnly(name: String): OperationalState
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  34. def withNameLowercaseOnlyEither(name: String): Either[NoSuchMember[OperationalState], OperationalState]
    Definition Classes
    Enum
  35. def withNameLowercaseOnlyOption(name: String): Option[OperationalState]
    Definition Classes
    Enum
  36. def withNameOption(name: String): Option[OperationalState]
    Definition Classes
    Enum
  37. def withNameUppercaseOnly(name: String): OperationalState
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  38. def withNameUppercaseOnlyEither(name: String): Either[NoSuchMember[OperationalState], OperationalState]
    Definition Classes
    Enum
  39. def withNameUppercaseOnlyOption(name: String): Option[OperationalState]
    Definition Classes
    Enum
  40. case object BUSY extends OperationalState with Product with Serializable
  41. case object ERROR extends OperationalState with Product with Serializable
  42. case object NOT_READY extends OperationalState with Product with Serializable
  43. case object READY extends OperationalState with Product with Serializable

Deprecated Value Members

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

Inherited from Enum[OperationalState]

Inherited from AnyRef

Inherited from Any

Ungrouped