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 core
    Definition Classes
    params
  • package formats
    Definition Classes
    core
  • package generics
    Definition Classes
    core
  • package models
    Definition Classes
    core
  • Angle
  • ArrayData
  • Choice
  • Choices
  • Coords
  • Id
  • JAngle
  • JCoords
  • JEqCoord
  • JStruct
  • MatrixData
  • ObsId
  • PMValue
  • Prefix
  • ProperMotion
  • RaDec
  • Struct
  • Subsystem
  • Units
  • package states
    Definition Classes
    core

package models

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class Angle(uas: Long) extends Serializable with Ordered[Angle] with Product

    An wrapper for angle.

    An wrapper for angle. Normally angle would be stored in double as radians, but this introduces rounding errors. This class stores value in microarc seconds to prevent rounding errors.

    Usage examples: //import provides implicit conversions for numbers import Angle._ //use implicit conversions to construct angle from number val angle = 10.degree + 0.5.arcSec //convert value to radian an print it println(11.toRadian)

  2. case class ArrayData[T](data: ArraySeq[T]) extends Product with Serializable

    A top level key for a parameter set representing an array like collection.

    A top level key for a parameter set representing an array like collection.

    data

    input array

  3. case class Choice(name: String) extends Product with Serializable

    Represents a single choice

    Represents a single choice

    name

    of the choice

  4. case class Choices(values: Set[Choice]) extends Product with Serializable

    Represents a set of choices

    Represents a set of choices

    values

    a Set of Choice

  5. case class Id(id: String) extends Product with Serializable

    Implementation of unique id fulfilling TMT requirements (returned from a queue submit).

    Implementation of unique id fulfilling TMT requirements (returned from a queue submit).

    id

    a string representation of unique id

  6. case class MatrixData[T](data: ArraySeq[ArraySeq[T]])(implicit evidence$1: ClassTag[T]) extends Product with Serializable

    A top level key for a parameter set representing an matrix like collection.

    A top level key for a parameter set representing an matrix like collection.

    data

    input array of array

  7. case class ObsId(obsId: String) extends Product with Serializable

    Represents a unique observation id

    Represents a unique observation id

    obsId

    the string representation of obsId

  8. final case class PMValue(uaspyr: Long) extends AnyVal with Serializable with Ordered[PMValue] with Product
  9. case class Prefix(prefix: String) extends Product with Serializable

    A top level key for a parameter set: combination of subsystem and the subsystem's prefix Eg.

    A top level key for a parameter set: combination of subsystem and the subsystem's prefix Eg. tcs.filter.wheel

    prefix

    the subsystem's prefix

  10. case class ProperMotion(pmx: Double, pmy: Double) extends Product with Serializable
  11. case class RaDec(ra: Double, dec: Double) extends Product with Serializable

    Holds Ra(Right Ascension) and Dec(Declination) values

  12. case class Struct extends ParameterSetType[Struct] with Product with Serializable

    A configuration for setting telescope and instrument parameters

  13. sealed abstract class Subsystem extends EnumEntry with Lowercase with Serializable

    Represents a TMT subsystem

  14. sealed abstract class Units extends EnumEntry

    A class representing units for TMT

Value Members

  1. object Angle extends Serializable
  2. object ArrayData extends Serializable
  3. object Choice extends Serializable

    Provides implicit conversion from String to Choice

  4. object Choices extends Serializable

    Provides a varargs constructor for Choices

  5. object Coords
  6. object Id extends Serializable
  7. object JAngle

    Java API for creating an Angle instance.

  8. object JCoords

    For the Java API

  9. object JEqCoord
  10. object JStruct

    A helper instance aJava

  11. object MatrixData extends Serializable
  12. object ObsId extends Serializable
  13. object Prefix extends Serializable
  14. object ProperMotion extends Serializable
  15. object Struct extends Serializable
  16. object Subsystem extends Enum[Subsystem] with Serializable

    Defines constants for the available subsystems

  17. object Units extends Enum[Units]

Ungrouped