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 core
    Definition Classes
    params
  • package models
    Definition Classes
    core
  • Angle
  • ArrayData
  • CalibrationLevel
  • Choice
  • Choices
  • Coords
  • ExposureId
  • ExposureIdWithObsId
  • ExposureNumber
  • Id
  • JAngle
  • JCoords
  • JEqCoord
  • MatrixData
  • ObsId
  • PMValue
  • ProgramId
  • ProperMotion
  • Semester
  • SemesterId
  • Separator
  • StandaloneExposureId
  • TYP
  • TYPLevel
  • Units

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

An wrapper for angle. Normally angle would be stored in double as radians, but this introduces rounding errors. This class stores value in microarcseconds 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)

Linear Supertypes
Product, Equals, Ordered[Angle], Comparable[Angle], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Angle
  2. Product
  3. Equals
  4. Ordered
  5. Comparable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Angle(uas: Long)

Value Members

  1. def *(a2: Int): Angle
  2. def *(a2: Double): Angle
  3. def +(a2: Angle): Angle
  4. def -(a2: Angle): Angle
  5. def /(a2: Int): Angle
  6. def /(a2: Double): Angle
  7. def <(that: Angle): Boolean
    Definition Classes
    Ordered
  8. def <=(that: Angle): Boolean
    Definition Classes
    Ordered
  9. def >(that: Angle): Boolean
    Definition Classes
    Ordered
  10. def >=(that: Angle): Boolean
    Definition Classes
    Ordered
  11. def compare(that: Angle): Int
    Definition Classes
    Angle → Ordered
  12. def compareTo(that: Angle): Int
    Definition Classes
    Ordered → Comparable
  13. def normalizedRa: Angle

    returns Angle with value normalized between 0 to 2*PI

  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. def to(maxVal: Angle, increment: Angle): Seq[Angle]

    Returns sequence of angles with given max value and increment

  16. def toArcSec: Double

    returns angle value in arcseconds

  17. def toDegree: Double

    returns angle value in degrees

  18. def toMas: Double

    returns angle value in milliarcseconds

  19. def toRadian: Double

    returns angle value in radians

  20. def toString(): String
    Definition Classes
    Angle → AnyRef → Any
  21. val uas: Long
  22. def unary_+: Angle
  23. def unary_-: Angle
  24. def until(maxVal: Angle, increment: Angle): Seq[Angle]

    Returns sequence of angles with given max value and increment