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 formats
    Definition Classes
    core
  • AdtCbor
  • CommandCbor
  • CommandIssueCbor
  • EventCbor
  • JParamCodecs
  • JavaJsonSupport
  • JsonSupport
  • ParamCodecs
  • ParamCodecsBase
  • ParamCore
  • Timestamp
t

csw.params.core.formats

ParamCodecsBase

trait ParamCodecsBase extends CommonCodecs

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParamCodecsBase
  2. CommonCodecs
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type ArrayDec[T] = Decoder[Array[T]]
  2. type ArrayEnc[T] = Encoder[Array[T]]
  3. case class Timestamp(seconds: Long, nanos: Long) extends Product with Serializable
    Definition Classes
    CommonCodecs

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. implicit lazy val angleCodec: Codec[Angle]
  5. implicit def arrayDataCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[ArrayData[T]]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. implicit lazy val bytesDec: Decoder[Array[Byte]]
  8. implicit lazy val bytesEnc: Encoder[Array[Byte]]
  9. implicit lazy val charDec: Decoder[Char]
  10. implicit lazy val charEnc: Encoder[Char]
  11. implicit lazy val characterDec: Decoder[Character]
  12. implicit lazy val characterEnc: Encoder[Character]
  13. implicit lazy val choiceCodec: Codec[Choice]
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  15. implicit lazy val commandIssueCodecValue: Codec[CommandIssue]
  16. implicit lazy val commandNameCodec: Codec[CommandName]
  17. lazy val commandResponseCodecValue: Codec[CommandResponse]
    Attributes
    protected
  18. implicit lazy val controlCommandCodec: Codec[ControlCommand]
  19. lazy val coordCodecValue: Codec[Coord]
  20. implicit lazy val currentStateCodecValue: Codec[CurrentState]
  21. implicit def enumCodec[T <: EnumEntry](implicit arg0: Enum[T]): Codec[T]
    Definition Classes
    CommonCodecs
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  24. implicit lazy val eventCodec: Codec[Event]
  25. implicit lazy val eventNameCodec: Codec[EventName]
  26. implicit lazy val finiteDurationCodec: Codec[FiniteDuration]
    Definition Classes
    CommonCodecs
  27. implicit val flatAdtEncoding: AdtEncodingStrategy
    Definition Classes
    CommonCodecs
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  30. implicit lazy val idCodec: Codec[Id]
  31. implicit lazy val instantDec: Decoder[Instant]
    Definition Classes
    CommonCodecs
  32. implicit lazy val instantEnc: Encoder[Instant]
    Definition Classes
    CommonCodecs
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. implicit lazy val javaByteArrayDec: Decoder[Array[Byte]]
  35. implicit lazy val javaByteArrayEnc: Encoder[Array[Byte]]
  36. implicit def matrixDataCodec[T](implicit arg0: ClassTag[T], arg1: ArrayEnc[T], arg2: ArrayDec[T]): Codec[MatrixData[T]]
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  40. implicit lazy val obsIdCodec: Codec[ObsId]
  41. implicit def paramCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[Parameter[T]]
  42. implicit def paramCoreCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[ParamCore[T]]
  43. implicit lazy val paramDecExistential: Decoder[Parameter[_]]
  44. implicit lazy val paramEncExistential: Encoder[Parameter[_]]
  45. implicit lazy val prefixCodec: Codec[Prefix]
    Definition Classes
    CommonCodecs
  46. implicit lazy val properMotionCodec: Codec[ProperMotion]
  47. implicit lazy val resultCodec: Codec[Result]
  48. implicit lazy val sequenceCodec: Codec[Sequence]
  49. implicit lazy val sequenceCommandCodec: Codec[SequenceCommand]
  50. implicit lazy val stateNameCodec: Codec[StateName]
  51. implicit lazy val stateVariableCodecValue: Codec[StateVariable]
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. implicit lazy val tagCodec: Codec[Tag]
  54. implicit lazy val taiTimeCodec: Codec[TAITime]
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. implicit lazy val utcTimeCodec: Codec[UTCTime]
  57. implicit def waCodec[T](implicit arg0: ArrayEnc[T], arg1: ArrayDec[T]): Codec[ArraySeq[T]]
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from CommonCodecs

Inherited from AnyRef

Inherited from Any

Ungrouped