SequenceCommand
Marker trait for sequence parameter sets which is applicable to Sequencer type of components
Attributes
- Graph
-
- Supertypes
- Known subtypes
Members list
Value members
Inherited methods
Adds a parameter to the parameter set
Adds a parameter to the parameter set
Type parameters
- P
-
the Parameter type
Value parameters
- parameter
-
the parameter to add
Attributes
- Returns
-
a new instance of this parameter set with the given parameter added
- Inherited from:
- ParameterSetType
Return the parameter associated with a Key rather than an Option
Return the parameter associated with a Key rather than an Option
Type parameters
- S
-
the Scala value type
Value parameters
- key
-
the Key to be used for lookup
Attributes
- Returns
-
the parameter associated with the Key or a NoSuchElementException if the key does not exist
- Inherited from:
- ParameterSetType
Returns true if the data contains the given key
A comma separated string representation of parameters
Returns true if the key exists in the parameter set
Returns true if the key exists in the parameter set
Type parameters
- S
-
the Scala value type
Value parameters
- key
-
the key to check for
Attributes
- Returns
-
true if the key is found
- Inherited from:
- ParameterSetType
Find a parameter based on it's keyName and keyType
Find a parameter based on it's keyName and keyType
Type parameters
- S
-
the type of values the Parameter holds
Value parameters
- parameter
-
who's keyName and keyType is used to get values and units
Attributes
- Returns
-
an Option of Parameter[S] if it is found, otherwise None
- Inherited from:
- ParameterSetType
Returns an Option with the parameter for the key if found, otherwise None
Returns an Option with the parameter for the key if found, otherwise None
Type parameters
- S
-
the value type
Value parameters
- keyName
-
the keyName for a key
- keyType
-
the keyType for a key
Attributes
- Returns
-
the parameter for the key, if found
- Inherited from:
- ParameterSetType
Returns an Option with the parameter for the key if found, otherwise None
Returns an Option with the parameter for the key if found, otherwise None
Type parameters
- S
-
the value type
Value parameters
- key
-
the Key to be used for lookup
Attributes
- Returns
-
the parameter for the key, if found
- Inherited from:
- ParameterSetType
Returns a map based on this object where the keys and values are in string get (Could be useful for exporting in a get that other languages can read). Derived classes might want to add values to this map for fixed fields.
Returns a map based on this object where the keys and values are in string get (Could be useful for exporting in a get that other languages can read). Derived classes might want to add values to this map for fixed fields.
Attributes
- Inherited from:
- ParameterSetType
A Java helper to find a parameter based on it's keyName and keyType
A Java helper to find a parameter based on it's keyName and keyType
Type parameters
- S
-
the type of values the Parameter holds
Value parameters
- parameter
-
who's keyName and keyType is used to get values and units
Attributes
- Returns
-
an Optional of Parameter[S] if it is found, otherwise empty
- Inherited from:
- ParameterSetType
Returns an Optional with the parameter for the key if found, otherwise empty
Returns an Optional with the parameter for the key if found, otherwise empty
Type parameters
- S
-
the value type
Value parameters
- keyName
-
the keyName for a key
- keyType
-
the keyType for a key
Attributes
- Returns
-
the parameter for the key, if found
- Inherited from:
- ParameterSetType
Returns an Optional with the parameter for the key if found, otherwise empty
Returns an Optional with the parameter for the key if found, otherwise empty
Type parameters
- S
-
the value type
Value parameters
- key
-
the Key to be used for lookup
Attributes
- Returns
-
the parameter for the key, if found
- Inherited from:
- ParameterSetType
A Java helper that returns a map based on this object where the keys and values are in string get (Could be useful for exporting in a get that other languages can read). Derived classes might want to add values to this map for fixed fields.
A Java helper that returns a map based on this object where the keys and values are in string get (Could be useful for exporting in a get that other languages can read). Derived classes might want to add values to this map for fixed fields.
Attributes
- Inherited from:
- ParameterSetType
Attributes
- Inherited from:
- ParameterSetType
A Java helper to acsess optional obsId
A Java helper to acsess optional obsId
Attributes
- Returns
-
an Optional of ObsId
- Inherited from:
- Command
A Java helper that returns a set containing the names of any of the given keys that are missing in the data
A Java helper that returns a set containing the names of any of the given keys that are missing in the data
Value parameters
- keys
-
one or more keys
Attributes
- Inherited from:
- ParameterSetType
A Java helper to get parameters for this parameter set
Adds several parameters to the parameter set
Adds several parameters to the parameter set
Type parameters
- P
-
must be a subclass of Parameter
Value parameters
- parametersToAdd
-
the list of parameters to add to the parameter set
Attributes
- Returns
-
a new instance of this parameter set with the given parameter added
- Note
-
madd ensures check for duplicate key
- Inherited from:
- ParameterSetType
Adds several parameters to the parameter set
Adds several parameters to the parameter set
Type parameters
- P
-
must be a subclass of Parameter
Value parameters
- parametersToAdd
-
the list of parameters to add to the parameter set
Attributes
- Returns
-
a new instance of this parameter set with the given parameter added
- Note
-
madd ensures check for duplicate key
- Inherited from:
- ParameterSetType
Returns a set containing the names of any of the given keys that are missing in the data
Returns a set containing the names of any of the given keys that are missing in the data
Value parameters
- keys
-
one or more keys
Attributes
- Returns
-
a Set of key names
- Inherited from:
- ParameterSetType
A helper to give access of public members of ParameterSetType
A helper to give access of public members of ParameterSetType
Attributes
- Returns
-
a handle to ParameterSetType extended by concrete implementation of this class
- Inherited from:
- Command
Returns the actual parameter associated with a key
Returns the actual parameter associated with a key
Type parameters
- S
-
the Scala value type
Value parameters
- key
-
the Key to be used for lookup
Attributes
- Returns
-
the parameter associated with the key or a NoSuchElementException if the key does not exist
- Inherited from:
- ParameterSetType
Removes a parameter based on the parameter
Removes a parameter based on the parameter
Type parameters
- P
-
the type of the parameter to be removed
Value parameters
- parameter
-
to be removed from the parameter set
Attributes
- Returns
-
a new T, where T is a parameter set child with the parameter removed or identical if the parameter is not present
- Inherited from:
- ParameterSetType
Remove a parameter from the parameter set by key
Remove a parameter from the parameter set by key
Type parameters
- S
-
the Scala value type
Value parameters
- key
-
the Key to be used for removal
Attributes
- Returns
-
a new T, where T is a parameter set child with the key removed or identical if the key is not present
- Inherited from:
- ParameterSetType
The number of parameters in this parameter set
The number of parameters in this parameter set
Attributes
- Returns
-
the number of parameters in the parameter set
- Inherited from:
- ParameterSetType
A common toString method for all concrete implementation
A common toString method for all concrete implementation
Attributes
- Returns
-
the string representation of command
- Definition Classes
- Inherited from:
- Command
A name identifying the type of parameter set, such as "setup", "observe". This is used in the JSON and toString output.
A name identifying the type of parameter set, such as "setup", "observe". This is used in the JSON and toString output.
Attributes
- Inherited from:
- ParameterSetType
Inherited and Abstract methods
Method called by subclass to create a copy with the same key (or other fields) and new parameters. It is protected and subclasses should also keep it as protected to avoid receiving duplicate keys.
Method called by subclass to create a copy with the same key (or other fields) and new parameters. It is protected and subclasses should also keep it as protected to avoid receiving duplicate keys.
Value parameters
- data
-
a new set of Parameters after addition or deletion
Attributes
- Returns
-
a concrete implementation of type T
- Inherited from:
- ParameterSetType
Inherited and Abstract fields
The name of command
An optional obsId for command
An optional initial set of parameters (keys with values)