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       |
| Timestamp    | KeyType.TimestampKey    | JKeyType.TimestampKey    |
| ----------   | ----------              | ----------                |
| 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       |
| RaDec        | KeyType.RaDecKey        | JKeyType.RaDecKey        |
| Struct       | KeyType.StructKey       | JKeyType.StructKey       |
+--------------+-------------------------+---------------------------+

    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
  • Event
  • EventKey
  • EventName
  • ObserveEvent
  • SystemEvent

sealed trait Event extends AnyRef

Common trait representing events in TMT like csw.params.events.SystemEvent and csw.params.events.ObserveEvent

Self Type
Event with ParameterSetType[_]
Linear Supertypes
AnyRef, Any
Known Subclasses
ObserveEvent, SystemEvent
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Event
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val eventId: Id

    unique Id for event

  2. abstract val eventName: EventName

    The name of event

  3. abstract val eventTime: UTCTime

    The time of event creation

  4. abstract val paramSet: Set[Parameter[_]]

    An optional initial set of parameters (keys with values)

  5. abstract val source: Prefix

    Prefix representing source of the event

  6. abstract def typeName: String

    A name identifying the type of parameter set, such as "SystemEvent", "ObserveEvent".

    A name identifying the type of parameter set, such as "SystemEvent", "ObserveEvent". This is used in the JSON and toString output.

    returns

    a string representation of concrete type of this class

Concrete Value Members

  1. def eventKey: EventKey

    The EventKey used to publish or subscribe an event

    The EventKey used to publish or subscribe an event

    returns

    an EventKey formed by combination of prefix and eventName of an event

  2. def isInvalid: Boolean
  3. def paramType: ParameterSetType[_]

    A helper to give access of public members of ParameterSetType

    A helper to give access of public members of ParameterSetType

    returns

    a handle to ParameterSetType extended by concrete implementation of this class

  4. def toString(): String

    A common toString method for all concrete implementation

    A common toString method for all concrete implementation

    returns

    the string representation of command

    Definition Classes
    Event → AnyRef → Any