Package org.yamcs.xtce

Class BaseTimeDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.BaseTimeDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

AbsoluteTimeDataType

public abstract class BaseTimeDataType
extends BaseDataType

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseTimeDataType.Builder<T extends BaseTimeDataType.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	BaseTimeDataType(BaseTimeDataType t)	creates a shallow copy of t

Method Summary

Modifier and Type	Method	Description
double	getOffset()
double	getScale()
boolean	needsScaling()
Object	parseStringForRawValue(String stringValue)	parses the string into a java object according to the parameter encoding
void	setScaling(double offset, double scale)	Scale and offset are used in a y = m*x + b type relationship (m is the scale and b is the offset) to make adjustments to the encoded value so that it matches the time units.

Methods inherited from class org.yamcs.xtce.BaseDataType

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

convertType, getInitialValue, getLongDescription, getName, getQualifiedName, getShortDescription, getTypeAsString, getValueType

Constructor Details

BaseTimeDataType

protected BaseTimeDataType(BaseTimeDataType t)

creates a shallow copy of t

Parameters:

t -

Method Details

parseStringForRawValue

public Object parseStringForRawValue(String stringValue)

Description copied from interface: DataType

parses the string into a java object according to the parameter encoding

Specified by:

parseStringForRawValue in interface DataType

Overrides:

parseStringForRawValue in class BaseDataType

Returns:

a java object representation

setScaling

public void setScaling(double offset,
 double scale)

Scale and offset are used in a y = m*x + b type relationship (m is the scale and b is the offset) to make adjustments to the encoded value so that it matches the time units.

Parameters:

offset -

scale -

needsScaling

public boolean needsScaling()

getOffset

public double getOffset()

getScale

public double getScale()