EnumeratedArgumentType (Yamcs :: XTCE 5.4.2 API)

java.lang.Object
- org.yamcs.xtce.NameDescription
- - org.yamcs.xtce.BaseDataType
  - - org.yamcs.xtce.EnumeratedDataType
    - - org.yamcs.xtce.EnumeratedArgumentType

All Implemented Interfaces:: Serializable, ArgumentType, DataType

public class EnumeratedArgumentType
extends EnumeratedDataType
implements ArgumentType

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EnumeratedArgumentType.Builder

Field Summary
- Fields inherited from class org.yamcs.xtce.EnumeratedDataType
  enumeration, enumerationList, ranges
- Fields inherited from class org.yamcs.xtce.BaseDataType
  encoding
- Fields inherited from class org.yamcs.xtce.NameDescription
  ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors
Constructor Description

EnumeratedArgumentType(EnumeratedArgumentType t)
Copy constructor

EnumeratedArgumentType(EnumeratedArgumentType.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`decalibrate(String label)`
`String`	`getCalibrationDescription()`
`String`	`getTypeAsString()`	String which represents the type.
`EnumeratedArgumentType.Builder`	`toBuilder()`	Create a shallow copy of the data type - the object itself (and the primitive fields) are new but the other fields reference to the same object like the original
`String`	`toString()`

Methods inherited from class org.yamcs.xtce.EnumeratedDataType
calibrate, enumValue, enumValue, getInitialValue, getValueEnumerationList, getValueEnumerationRangeList, getValueType, hasLabel, parseString, setInitialValue

Methods inherited from class org.yamcs.xtce.BaseDataType
getEncoding, getUnitSet, parseStringForRawValue, setInitialValue, toString

Methods inherited from class org.yamcs.xtce.NameDescription
addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, setShortDescription

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.ArgumentType
getName, getUnitSet

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

- Constructor Detail
  - EnumeratedArgumentType
```
public EnumeratedArgumentType(EnumeratedArgumentType.Builder builder)
```
  - EnumeratedArgumentType
```
public EnumeratedArgumentType(EnumeratedArgumentType t)
```
    Copy constructor
- Method Detail
  - decalibrate
```
public long decalibrate(String label)
```
  - getCalibrationDescription
```
public String getCalibrationDescription()
```
  - getTypeAsString
```
public String getTypeAsString()
```
    Description copied from interface: DataType
    
    String which represents the type. This string will be presented to the users of the system.
    
    Specified by:
    
    getTypeAsString in interface ArgumentType
    
    Specified by:
    
    getTypeAsString in interface DataType
    
    Overrides:
    
    getTypeAsString in class EnumeratedDataType
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBuilder
```
public EnumeratedArgumentType.Builder toBuilder()
```
    Description copied from interface: ArgumentType
    
    Create a shallow copy of the data type - the object itself (and the primitive fields) are new but the other fields reference to the same object like the original
    
    Specified by:
    
    toBuilder in interface ArgumentType
    
    Returns: