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 generics
    Definition Classes
    core
  • ArrayKeyType
  • GChoiceKey
  • Key
  • KeyType
  • MatrixKeyType
  • Parameter
  • ParameterSetFilters
  • ParameterSetKeyData
  • ParameterSetType
  • SimpleKeyType
  • SimpleKeyTypeWithUnits

object KeyType extends Enum[KeyType[_]] with Serializable

KeyTypes defined for consumption in Scala code

Linear Supertypes
Serializable, Enum[KeyType[_]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyType
  2. Serializable
  3. Enum
  4. AnyRef
  5. 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, KeyType[_]]
    Definition Classes
    Enum
  9. macro def findValues: IndexedSeq[KeyType[_]]
    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: KeyType[_]): Int
    Definition Classes
    Enum
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final lazy val lowerCaseNamesToValuesMap: Map[String, KeyType[_]]
    Definition Classes
    Enum
  15. lazy val namesToValuesMap: Map[String, KeyType[_]]
    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 toString(): String
    Definition Classes
    AnyRef → Any
  21. final lazy val upperCaseNameValuesToMap: Map[String, KeyType[_]]
    Definition Classes
    Enum
  22. def values: IndexedSeq[KeyType[_]]

    values return a Seq of all KeyTypes provided by csw-messages

    values return a Seq of all KeyTypes provided by csw-messages

    Definition Classes
    KeyType → Enum
  23. final lazy val valuesToIndex: Map[KeyType[_], Int]
    Definition Classes
    Enum
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. def withName(name: String): KeyType[_]
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  28. def withNameEither(name: String): Either[NoSuchMember[KeyType[_]], KeyType[_]]
    Definition Classes
    Enum
  29. def withNameInsensitive(name: String): KeyType[_]
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  30. def withNameInsensitiveEither(name: String): Either[NoSuchMember[KeyType[_]], KeyType[_]]
    Definition Classes
    Enum
  31. def withNameInsensitiveOption(name: String): Option[KeyType[_]]
    Definition Classes
    Enum
  32. def withNameLowercaseOnly(name: String): KeyType[_]
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  33. def withNameLowercaseOnlyEither(name: String): Either[NoSuchMember[KeyType[_]], KeyType[_]]
    Definition Classes
    Enum
  34. def withNameLowercaseOnlyOption(name: String): Option[KeyType[_]]
    Definition Classes
    Enum
  35. def withNameOption(name: String): Option[KeyType[_]]
    Definition Classes
    Enum
  36. def withNameUppercaseOnly(name: String): KeyType[_]
    Definition Classes
    Enum
    Annotations
    @SuppressWarnings()
  37. def withNameUppercaseOnlyEither(name: String): Either[NoSuchMember[KeyType[_]], KeyType[_]]
    Definition Classes
    Enum
  38. def withNameUppercaseOnlyOption(name: String): Option[KeyType[_]]
    Definition Classes
    Enum
  39. case object AltAzCoordKey extends SimpleKeyType[AltAzCoord] with Product with Serializable
  40. case object BooleanKey extends SimpleKeyTypeWithUnits[Boolean] with Product with Serializable
  41. case object ByteArrayKey extends ArrayKeyType[Byte] with Product with Serializable
  42. case object ByteKey extends SimpleKeyType[Byte] with Product with Serializable
  43. case object ByteMatrixKey extends MatrixKeyType[Byte] with Product with Serializable
  44. case object CharKey extends SimpleKeyType[Char] with Product with Serializable
  45. case object ChoiceKey extends KeyType[Choice] with Product with Serializable
  46. case object CometCoordKey extends SimpleKeyType[CometCoord] with Product with Serializable
  47. case object CoordKey extends SimpleKeyType[Coord] with Product with Serializable
  48. case object DoubleArrayKey extends ArrayKeyType[Double] with Product with Serializable
  49. case object DoubleKey extends SimpleKeyType[Double] with Product with Serializable
  50. case object DoubleMatrixKey extends MatrixKeyType[Double] with Product with Serializable
  51. case object EqCoordKey extends SimpleKeyType[EqCoord] with Product with Serializable
  52. case object FloatArrayKey extends ArrayKeyType[Float] with Product with Serializable
  53. case object FloatKey extends SimpleKeyType[Float] with Product with Serializable
  54. case object FloatMatrixKey extends MatrixKeyType[Float] with Product with Serializable
  55. case object IntArrayKey extends ArrayKeyType[Int] with Product with Serializable
  56. case object IntKey extends SimpleKeyType[Int] with Product with Serializable
  57. case object IntMatrixKey extends MatrixKeyType[Int] with Product with Serializable
  58. case object LongArrayKey extends ArrayKeyType[Long] with Product with Serializable
  59. case object LongKey extends SimpleKeyType[Long] with Product with Serializable
  60. case object LongMatrixKey extends MatrixKeyType[Long] with Product with Serializable
  61. case object MinorPlanetCoordKey extends SimpleKeyType[MinorPlanetCoord] with Product with Serializable
  62. case object ShortArrayKey extends ArrayKeyType[Short] with Product with Serializable
  63. case object ShortKey extends SimpleKeyType[Short] with Product with Serializable
  64. case object ShortMatrixKey extends MatrixKeyType[Short] with Product with Serializable
  65. case object SolarSystemCoordKey extends SimpleKeyType[SolarSystemCoord] with Product with Serializable
  66. case object StringKey extends SimpleKeyType[String] with Product with Serializable
  67. case object TAITimeKey extends SimpleKeyTypeWithUnits[TAITime] with Product with Serializable
  68. case object UTCTimeKey extends SimpleKeyTypeWithUnits[UTCTime] 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 Serializable

Inherited from Enum[KeyType[_]]

Inherited from AnyRef

Inherited from Any

Ungrouped