Public Member Functions | |
| double | getDoubleValue () |
| Used only by the THistoryRecord class in retrieving the primary double floating point value for this compound data object (if available). More... | |
| int | getIntegerValue () |
| Used only by the THistoryRecord class in retrieving the primary 32-bit integer value for this compound data object (if available). More... | |
| void | setFieldSeparator (String value) |
| sets the field separator token used the the toString() method More... | |
| String | getCsvString () |
| Used by TDataType.toCsvString() to get a valid parse-able string to of the objects data contents to supply to csv files. | |
| int | getSizeInBytes () |
| Used by TDataType, TTaggedStruct and other routines. More... | |
| short | getFormat () |
| Used by TDataType, TTaggedStruct and other routines. More... | |
| String | getTag () |
| Used by TDataType, TTaggedStruct and other routines. More... | |
| void | setByteArray (byte[] byteArray) |
| Sets the underlying bytestream to that give Used only by the HISTORY data type for manipulating compound data types. More... | |
| byte[] | getByteArray () |
| Passive method that simple returns the reference to the underlying bytestream Used by TDataType(), TTaggedStruct, and THistoryRecord. More... | |
| byte[] | toByteArray () |
| Active method to convert the relevant data fields of this compound data type into the underlying byte stream (data being sent). More... | |
| void | toStruct () |
| Active method to convert the underlying byte stream to the relevant data fields of this compound data type. More... | |
Detailed Description
- Deprecated:
- please use INTFLTINT instead
Member Function Documentation
◆ getByteArray()
| byte [] de.desy.tine.types.TDS.getByteArray | ( | ) |
Passive method that simple returns the reference to the underlying bytestream Used by TDataType(), TTaggedStruct, and THistoryRecord.
- Returns
- a reference to the underlying bytestream (if any)
Implements de.desy.tine.types.TCompoundDataObject.
References de.desy.tine.types.TDS.toByteArray().
◆ getDoubleValue()
| double de.desy.tine.types.TDS.getDoubleValue | ( | ) |
Used only by the THistoryRecord class in retrieving the primary double floating point value for this compound data object (if available).
If the compound data object has no double value, then a '0' is returned.
- Returns
- the canonical double value part of this compound data object.
Implements de.desy.tine.types.TCompoundDataObject.
◆ getFormat()
| short de.desy.tine.types.TDS.getFormat | ( | ) |
Used by TDataType, TTaggedStruct and other routines.
- Returns
- the format code of this compound data type
Implements de.desy.tine.types.TCompoundDataObject.
◆ getIntegerValue()
| int de.desy.tine.types.TDS.getIntegerValue | ( | ) |
Used only by the THistoryRecord class in retrieving the primary 32-bit integer value for this compound data object (if available).
If the compound data object has no integer value, then a '0' is returned.
- Returns
- the canonical integer value part of this compound data object.
Implements de.desy.tine.types.TCompoundDataObject.
◆ getSizeInBytes()
| int de.desy.tine.types.TDS.getSizeInBytes | ( | ) |
Used by TDataType, TTaggedStruct and other routines.
- Returns
- the size in bytes of the of this compound data type
Implements de.desy.tine.types.TCompoundDataObject.
◆ getTag()
| String de.desy.tine.types.TDS.getTag | ( | ) |
Used by TDataType, TTaggedStruct and other routines.
- Returns
- the data tag of this compound data type
Implements de.desy.tine.types.TCompoundDataObject.
◆ setByteArray()
| void de.desy.tine.types.TDS.setByteArray | ( | byte[] | byteArray | ) |
Sets the underlying bytestream to that give Used only by the HISTORY data type for manipulating compound data types.
- Parameters
-
byteArray a new reference to an underlying bytestream
Implements de.desy.tine.types.TCompoundDataObject.
◆ setFieldSeparator()
| void de.desy.tine.types.TDS.setFieldSeparator | ( | String | value | ) |
sets the field separator token used the the toString() method
- Parameters
-
value
Implements de.desy.tine.types.TCompoundDataObject.
◆ toByteArray()
| byte [] de.desy.tine.types.TDS.toByteArray | ( | ) |
Active method to convert the relevant data fields of this compound data type into the underlying byte stream (data being sent).
This primarily involves byte swapping from big-endian to little-endian. Used systematically by TDataType() and other routines.
- Returns
- a reference to the underlying bytestream (as a courtesy)
Implements de.desy.tine.types.TCompoundDataObject.
Referenced by de.desy.tine.types.TDS.getByteArray().
◆ toStruct()
| void de.desy.tine.types.TDS.toStruct | ( | ) |
Active method to convert the underlying byte stream to the relevant data fields of this compound data type.
(data being received). This primarily involved swapping from little-endian to big-endian. Used systematically by TDataType() and other routines.
- Returns
Implements de.desy.tine.types.TCompoundDataObject.
The documentation for this class was generated from the following file:
- TDS.java
