de.desy.tine.types.TCompoundDataObject Interface Reference

interface for most TINE complex data types More...

Inheritance diagram for de.desy.tine.types.TCompoundDataObject:

List of all members.

Public Member Functions
byte[]	toByteArray ()
	Active method to convert the relevant data fields of this compound data type into the underlying byte stream (data being sent).
void	toStruct ()
	Active method to convert the underlying byte stream to the relevant data fields of this compound data type.
byte[]	getByteArray ()
	Passive method that simple returns the reference to the underlying bytestream Used by TDataType(), TTaggedStruct, and THistoryRecord.
void	setByteArray (byte[] byteArray)
	Sets the underlying bytestream to that give Used only by the HISTORY data type for manipulating compound data types.
int	getSizeInBytes ()
	Used by TDataType, TTaggedStruct and other routines.
short	getFormat ()
	Used by TDataType, TTaggedStruct and other routines.
String	getTag ()
	Used by TDataType, TTaggedStruct and other routines.
double	getDoubleValue ()
	Used only by the THistoryRecord class in retrieving the primary double floating point value for this compound data object (if available).
int	getIntegerValue ()
	Used only by the THistoryRecord class in retrieving the primary 32-bit integer value for this compound data object (if available).
String	getCsvString ()
	Used by TDataType.toCsvString() to get a valid parse-able string to of the objects data contents to supply to csv files.

---

Detailed Description

interface for most TINE complex data types

Author:

duval

---

Member Function Documentation

byte [] de.desy.tine.types.TCompoundDataObject.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)

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

double de.desy.tine.types.TCompoundDataObject.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.

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

short de.desy.tine.types.TCompoundDataObject.getFormat

(

)

Used by TDataType, TTaggedStruct and other routines.

Returns:

the format code of this compound data type

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

int de.desy.tine.types.TCompoundDataObject.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.

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

int de.desy.tine.types.TCompoundDataObject.getSizeInBytes

(

)

Used by TDataType, TTaggedStruct and other routines.

Returns:

the size in bytes of the of this compound data type

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

String de.desy.tine.types.TCompoundDataObject.getTag

(

)

Used by TDataType, TTaggedStruct and other routines.

Returns:

the data tag of this compound data type

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

void de.desy.tine.types.TCompoundDataObject.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

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

byte [] de.desy.tine.types.TCompoundDataObject.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)

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

void de.desy.tine.types.TCompoundDataObject.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:

Implemented in de.desy.tine.types.DBLINT, de.desy.tine.types.IMAGE, de.desy.tine.types.LNGINT, and de.desy.tine.types.TDS.

---

The documentation for this interface was generated from the following file:

• TCompoundDataObject.java