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 commands
    Definition Classes
    params
  • Command
  • CommandIssue
  • CommandList
  • CommandName
  • CommandResponse
  • ControlCommand
  • Keys
  • Nameable
  • Observe
  • Result
  • Sequence
  • SequenceCommand
  • Setup
  • Wait

object CommandIssue

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommandIssue
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class AssemblyBusyIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when an Assembly receives a command and one is already executing

    Returned when an Assembly receives a command and one is already executing

    reason

    describing the cause of this issue

  2. final case class HCDBusyIssue(reason: String) extends CommandIssue with Product with Serializable

    A required HCD is busy and cannot be used

    A required HCD is busy and cannot be used

    reason

    describing the cause of this issue

  3. final case class IdNotAvailableIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when a CommandResponse associated with runId is not available

    Returned when a CommandResponse associated with runId is not available

    reason

    describing the cause of this issue

  4. final case class MissingKeyIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when a command is missing a required key/parameter

    Returned when a command is missing a required key/parameter

    reason

    describing the cause of this issue

  5. final case class OtherIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when some other issue occurred apart from those already defined

    Returned when some other issue occurred apart from those already defined

    reason

    describing the cause of this issue

  6. final case class ParameterValueOutOfRangeIssue(reason: String) extends CommandIssue with Product with Serializable

    Parameter of a command is out of range

    Parameter of a command is out of range

    reason

    describing the cause of this issue

  7. final case class RequiredAssemblyUnavailableIssue(reason: String) extends CommandIssue with Product with Serializable

    A required Assembly is not available

    A required Assembly is not available

    reason

    describing the cause of this issue

  8. final case class RequiredHCDUnavailableIssue(reason: String) extends CommandIssue with Product with Serializable

    A required HCD is not available

    A required HCD is not available

    reason

    describing the cause of this issue

  9. final case class RequiredSequencerUnavailableIssue(reason: String) extends CommandIssue with Product with Serializable

    A required Sequencer is not available

    A required Sequencer is not available

    reason

    describing the cause of this issue

  10. final case class RequiredServiceUnavailableIssue(reason: String) extends CommandIssue with Product with Serializable

    A required service is not available

    A required service is not available

    reason

    describing the cause of this issue

  11. final case class UnresolvedLocationsIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when some required location is not available

    Returned when some required location is not available

    reason

    describing the cause of this issue

  12. final case class UnsupportedCommandInStateIssue(reason: String) extends CommandIssue with Product with Serializable

    A command is unsupported in the current state

    A command is unsupported in the current state

    reason

    describing the cause of this issue

  13. final case class UnsupportedCommandIssue(reason: String) extends CommandIssue with Product with Serializable

    A command is unsupported by component

    A command is unsupported by component

    reason

    describing the cause of this issue

  14. final case class WrongCommandTypeIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when some given command type is not expected

    Returned when some given command type is not expected

    reason

    describing the cause of this issue

  15. final case class WrongInternalStateIssue(reason: String) extends CommandIssue with Product with Serializable

    The component is in the wrong internal state to handle a command

    The component is in the wrong internal state to handle a command

    reason

    describing the cause of this issue

  16. final case class WrongNumberOfParametersIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when a command does not have the correct number of parameters

    Returned when a command does not have the correct number of parameters

    reason

    describing the cause of this issue

  17. final case class WrongParameterTypeIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when the parameter for a key is not the correct type (i.e.

    Returned when the parameter for a key is not the correct type (i.e. int vs double, etc.)

    reason

    describing the cause of this issue

  18. final case class WrongPrefixIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when an Assembly receives a configuration with a Prefix that it doesn't support

    Returned when an Assembly receives a configuration with a Prefix that it doesn't support

    reason

    describing the cause of this issue

  19. final case class WrongUnitsIssue(reason: String) extends CommandIssue with Product with Serializable

    Returned when a parameter value does not have the correct units

    Returned when a parameter value does not have the correct units

    reason

    describing the cause of this issue

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped