Module org.yamcs.xtce

Package org.yamcs.xtce

Class BooleanDataType

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.BaseDataType

org.yamcs.xtce.BooleanDataType

All Implemented Interfaces:

Serializable, DataType

Direct Known Subclasses:

BooleanArgumentType, BooleanParameterType

public class BooleanDataType
extends BaseDataType

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ONE_STRING_VALUE
static final String	DEFAULT_ZERO_STRING_VALUE

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	BooleanDataType(BooleanDataType t)
protected	BooleanDataType(BooleanDataType.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
Boolean	convertType(Object value)	Converts to the canonical (boxed) java representation of this type.
Boolean	getInitialValue()	Get the initial value if any
String	getOneStringValue()
String	getTypeAsString()	String which represents the type.
org.yamcs.protobuf.Yamcs.Value.Type	getValueType()	Return the expected Value type of an engineering value conforming to this XTCE data type
String	getZeroStringValue()
protected void	setInitialValue(Object initialValue)
String	toString()
String	toString(Object o)	Converts a value to a string.

Methods inherited from class org.yamcs.xtce.BaseDataType

getEncoding, getUnitSet, parseStringForRawValue, setInitialValue, setUnitSet

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, wait, wait, wait

Methods inherited from interface org.yamcs.xtce.DataType

getLongDescription, getName, getQualifiedName, getShortDescription

Field Details

DEFAULT_ONE_STRING_VALUE

public static final String DEFAULT_ONE_STRING_VALUE

See Also:

• Constant Field Values

DEFAULT_ZERO_STRING_VALUE

public static final String DEFAULT_ZERO_STRING_VALUE

See Also:

• Constant Field Values

Constructor Details

BooleanDataType

protected BooleanDataType(BooleanDataType.Builder<?> builder)

BooleanDataType

protected BooleanDataType(BooleanDataType t)

Method Details

setInitialValue

protected void setInitialValue(Object initialValue)

Specified by:

setInitialValue in class BaseDataType

getInitialValue

public Boolean getInitialValue()

Description copied from interface: DataType

Get the initial value if any

Returns:

convertType

public Boolean 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

toString

public String toString(Object o)

Description copied from interface: DataType

Converts a value to a string.

Specified by:

toString in interface DataType

Overrides:

toString in class BaseDataType

Returns:

getOneStringValue

public String getOneStringValue()

getZeroStringValue

public String getZeroStringValue()

getValueType

public org.yamcs.protobuf.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:

toString

public String toString()

Overrides:

toString in class Object