ParameterType (Yamcs :: XTCE 5.4.2 API)

All Superinterfaces:

DataType

All Known Subinterfaces:

NumericParameterType

All Known Implementing Classes:

AbsoluteTimeParameterType, AggregateParameterType, ArrayParameterType, BinaryParameterType, BooleanParameterType, EnumeratedParameterType, FloatParameterType, IntegerParameterType, StringParameterType
```
public interface ParameterType
extends DataType
```
Interface implemented by all the parameters types.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface ParameterType.Builder<T extends ParameterType.Builder<T>>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Set<Parameter>`	`getDependentParameters()`
`DataEncoding`	`getEncoding()`	Get the data encoding for the parameter type.
`boolean`	`hasAlarm()`	Whether this ParameterType has any alarms associated
`Object`	`parseString(String stringValue)`	parses the string into a java object according to the parameter type
`Object`	`parseStringForRawValue(String stringValue)`	parses the string into a java object according to the parameter encoding
`<T extends ParameterType> ParameterType.Builder<?>`	`toBuilder()`	Create a builder that can be used to make shallow copy of the parameter type

Methods inherited from interface org.yamcs.xtce.DataType
getInitialValue, getLongDescription, getName, getShortDescription, getTypeAsString, getValueType, toString

- Method Detail
  - getDependentParameters
```
default Set<Parameter> getDependentParameters()
```
    Returns:
    
    the set of parameters on which this one depends in order to be extracted or alarm checked can be an empty set if this parameter does not depend on any other
  - hasAlarm
```
boolean hasAlarm()
```
    Whether this ParameterType has any alarms associated
  - parseString
```
Object parseString(String stringValue)
```
    parses the string into a java object according to the parameter type
    
    Specified by:
    
    parseString in interface DataType
    
    Parameters:
    
    stringValue -
    
    Returns:
  - parseStringForRawValue
```
Object parseStringForRawValue(String stringValue)
```
    parses the string into a java object according to the parameter encoding
    
    Parameters:
    
    stringValue -
    
    Returns:
  - getEncoding
```
DataEncoding getEncoding()
```
    Get the data encoding for the parameter type.
    For arrays and aggregates types that do not have encoding; this operation will throw an UnsupportedOperationException
    
    Returns:
  - toBuilder
```
<T extends ParameterType> ParameterType.Builder<?> toBuilder()
```
    Create a builder that can be used to make shallow copy of the parameter type
    all the fields reference to the same object like the original
    
    Returns: