Package org.yamcs.xtce

Class AbsoluteTimeDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.BaseTimeDataType

org.yamcs.xtce.AbsoluteTimeDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

AbsoluteTimeArgumentType, AbsoluteTimeParameterType

public abstract class AbsoluteTimeDataType
extends BaseTimeDataType

Used to contain an absolute time. Contains an absolute (to a known epoch) time. Use the [ISO 8601] extended format CCYY-MM-DDThh:mm:ss where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day, preceded by an optional leading "-" sign to indicate a negative number. If the sign is omitted, "+" is assumed. The letter "T" is the date/time separator and "hh", "mm", "ss" represent hour, minute and second respectively. Additional digits can be used to increase the precision of fractional seconds if desired i.e. the format ss.ss... with any number of digits after the decimal point is supported.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbsoluteTimeDataType.Builder<T extends AbsoluteTimeDataType.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	AbsoluteTimeDataType(String name)
protected	AbsoluteTimeDataType(AbsoluteTimeDataType t)
protected	AbsoluteTimeDataType(AbsoluteTimeDataType.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
ReferenceTime	getReferenceTime()
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)	sets the initial value in UTC ISO 8860 string

Methods inherited from class org.yamcs.xtce.BaseTimeDataType

getOffset, getScale, needsScaling, parseStringForRawValue, setScaling

Methods inherited from class org.yamcs.xtce.BaseDataType

getEncoding, getUnitSet, 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

AbsoluteTimeDataType

protected AbsoluteTimeDataType(AbsoluteTimeDataType.Builder<?> builder)

AbsoluteTimeDataType

protected AbsoluteTimeDataType(String name)

AbsoluteTimeDataType

protected AbsoluteTimeDataType(AbsoluteTimeDataType t)

Method Details

getReferenceTime

public ReferenceTime getReferenceTime()

setInitialValue

protected void setInitialValue(Object initialValue)

sets the initial value in UTC ISO 8860 string

Specified by:

setInitialValue in class BaseDataType

getInitialValue

public String getInitialValue()

Description copied from interface: DataType

Get the initial value if any

Returns:

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: