Package org.yamcs.xtce
Class IntegerDataType
java.lang.Object
org.yamcs.xtce.NameDescription
org.yamcs.xtce.BaseDataType
org.yamcs.xtce.NumericDataType
org.yamcs.xtce.IntegerDataType
- All Implemented Interfaces:
Serializable
,DataType
- Direct Known Subclasses:
IntegerArgumentType
,IntegerParameterType
Contains an integral value.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
IntegerDataType.Builder<T extends IntegerDataType.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
ModifierConstructorDescriptionprotected
protected
IntegerDataType
(IntegerDataType.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionconvertType
(Object value) In case the provided value is a String, it is parsed to a Long Base 10 (decimal) form unless: if preceded by a 0b or 0B, value is in base two (binary form) if preceded by a 0o or 0O, values is in base 8 (octal) form if preceded by a 0x or 0X, value is in base 16 (hex) form. Underscores (_) are allowed in the string and ignored.Get the initial value if anyint
String which represents the type.returns the range for the values of this type to be valid or null if there is no range set (meaning that all values are valid)Return the expected Value type of an engineering value conforming to this XTCE data typeboolean
isSigned()
void
setInitialValue
(Long initialValue) 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
-
Field Details
-
signed
protected boolean signed
-
-
Constructor Details
-
IntegerDataType
-
IntegerDataType
-
-
Method Details
-
isSigned
public boolean isSigned() -
getSizeInBits
public int getSizeInBits() -
setInitialValue
- Specified by:
setInitialValue
in classBaseDataType
-
getValidRange
returns the range for the values of this type to be valid or null if there is no range set (meaning that all values are valid)- Returns:
-
setInitialValue
-
getInitialValue
Description copied from interface:DataType
Get the initial value if any- Returns:
-
getNumberFormat
-
convertType
In case the provided value is a String, it is parsed to a Long Base 10 (decimal) form unless:- if preceded by a 0b or 0B, value is in base two (binary form)
- if preceded by a 0o or 0O, values is in base 8 (octal) form
- if preceded by a 0x or 0X, value is in base 16 (hex) form.
NumberFormatException
if the value cannot be parsed or does not fit within the specified number of bits- Parameters:
value
- value to be converted, use boxed primitive values.- Returns:
- The preferred java object representation
-
getValueType
Description copied from interface:DataType
Return the expected Value type of an engineering value conforming to this XTCE data type- Returns:
-
getTypeAsString
Description copied from interface:DataType
String which represents the type. This string will be presented to the users of the system.- Returns:
-