Package org.yamcs.xtce

Class StringDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.StringDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

StringArgumentType, StringParameterType

public class StringDataType
extends BaseDataType

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringDataType.Builder<T extends StringDataType.Builder<T>>

Field Summary

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

Modifier	Constructor	Description
protected	StringDataType(StringDataType t)
protected	StringDataType(StringDataType.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
String	convertType(Object value)	Converts to the canonical (boxed) java representation of this type.
String	getInitialValue()	Get the initial value if any
IntegerRange	getSizeRangeInCharacters()
String	getTypeAsString()	String which represents the type.
Yamcs.Value.Type	getValueType()	Return the expected Value type of an engineering value conforming to this XTCE data type
protected void	setInitialValue(Object initialValue)

Methods inherited from class org.yamcs.xtce.BaseDataType

getEncoding, getUnitSet, parseStringForRawValue, setInitialValue, setUnitSet, toString

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, qualifiedName, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.DataType

getLongDescription, getName, getQualifiedName, getShortDescription

Constructor Details

StringDataType

protected StringDataType(StringDataType.Builder<?> builder)

StringDataType

protected StringDataType(StringDataType t)

Method Details

setInitialValue

protected void setInitialValue(Object initialValue)

Specified by:

setInitialValue in class BaseDataType

getInitialValue

public String getInitialValue()

Description copied from interface: DataType

Get the initial value if any

Returns:

getSizeRangeInCharacters

public IntegerRange getSizeRangeInCharacters()

convertType

public String convertType(Object value)

Description copied from interface: DataType

Converts to the canonical (boxed) java representation of this type.

For example, if value is a String, an integer-like DataType should parse the String value, and return an Integer result.

Parameters:

value - value to be converted, use boxed primitive values.

Returns:

The preferred java object representation

getValueType

public Yamcs.Value.Type getValueType()

Description copied from interface: DataType

Return the expected Value type of an engineering value conforming to this XTCE data type

Returns:

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.

Returns: