Main Page | Features | Central Services | csv-Files | Types | Transfer | Access | API-C | API-.NET | API-Java | Examples | Downloads
page generated on 31.05.2023 - 04:45
Public Member Functions | Static Public Member Functions | List of all members
de.desy.tine.dataUtils.TDataType Class Reference

TINE Data Type object All data transfered client <-> server must be contained in a TDataType object. More...

Inherits Cloneable.

Public Member Functions

void setArrayDelimiter (String delimiter)
 Sets the delimiter used in a string representation of an array.
 
String getArrayDelimiter ()
 Get the delimiter used in a string representation of an array. More...
 
 TDataType ()
 NULL element.
 
 TDataType (int dataSize, short dataFormat)
 An unbound DataType object of the specified size and format. More...
 
int getTimeStamp ()
 Returns the associated data timestamp as traditional UNIX timestamp (seconds since 1.1.1970).
 
long getDataTimeStamp ()
 Returns the associated data timestamp as JAVA timestamp (milliseconds since 1.1.1970).
 
void setDataTimeStamp (long TimeStamp)
 Sets the associated data timestamp from a JAVA timestamp (milliseconds since 1.1.1970).
 
void setDataTimeStamp (double TimeStamp)
 Sets the associated data timestamp from a TINE timestamp (seconds since 1.1.1970 + fractional seconds).
 
int getLastDataSize ()
 Returns the associated data completion length.
 
 TDataType (byte[] data)
 A subset of an array of booleans. More...
 
 TDataType (byte[] data, int length)
 A subset of an array of bytes. More...
 
 TDataType (byte[] data, String tag)
 An array of 'structs' with the given tag or untagged structs if tag.length == 0 User-defined structures are allowed in tine and not too difficult to use. More...
 
 TDataType (TTaggedStructure data)
 A Tagged Structure User-defined structures are allowed in tine and not too difficult to use. More...
 
 TDataType (TTaggedStructure[] data)
 A array of Tagged Structures User-defined structures are allowed in tine and not too difficult to use. More...
 
 TDataType (short[] data)
 An array of shorts (2-byte integers) This corresponds to tine format CF_SHORT. More...
 
 TDataType (short[] data, int length)
 A subset of an array of shorts (2-byte integers) This corresponds to tine format CF_SHORT. More...
 
 TDataType (short data)
 A single short value This method is only useful for quick creation of data 'down' objects (i.e. More...
 
 TDataType (int[] data)
 An array of ints (4-byte integers) This corresponds to tine format CF_LONG. More...
 
 TDataType (int[] data, int length)
 A subset of an array of ints (4-byte integers) This corresponds to tine format CF_LONG. More...
 
 TDataType (boolean[] data)
 A subset of an array of booleans. More...
 
 TDataType (boolean[] data, int length)
 A subset of an array of booleans. More...
 
 TDataType (float[] data)
 An array of floats This corresponds to tine format CF_FLOAT. More...
 
 TDataType (float[] data, int length)
 A subset of an array of floats This corresponds to tine format CF_FLOAT. More...
 
 TDataType (TCompoundDataObject[] data)
 An array of tine data objects (e.g. More...
 
 TDataType (TCompoundDataObject[] data, int length)
 An array of tine data objects (e.g. More...
 
 TDataType (SPECTRUM data)
 A SPECTRUM object. More...
 
 TDataType (IMAGE data)
 An IMAGE object. More...
 
 TDataType (double[] data)
 An array of doubles. More...
 
 TDataType (double[] data, int length)
 A subset of an array of doubles. More...
 
 TDataType (long[] data)
 An array of (Java) longs. More...
 
 TDataType (long[] data, int length)
 A subset of an array of (java) longs. More...
 
int getData (byte[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (byte[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (short[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (short[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int putData (short data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (short[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (short[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (short value, int offset)
 Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (short[] values, int offset)
 Puts the input data value array into the underlying byte stream, properly swapped and aligned. More...
 
int getData ()
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (boolean[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (boolean[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (int[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (int[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int putData (boolean data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (boolean[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (boolean[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (boolean value, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (int data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (int[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (int[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (int value, int offset)
 Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (int[] values, int offset)
 Puts the input data value array into the underlying byte stream, properly swapped and aligned. More...
 
int getData (float[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (float[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (TTaggedStructure[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (TTaggedStructure[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (TCompoundDataObject[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (TCompoundDataObject[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (SPECTRUM data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (IMAGE image)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int putData (float data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData ()
 Puts the current canonical data set into the underlying data byte stream Puts the currently referenced canonical data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (float[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (float[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (float value, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (float[] values, int offset)
 Puts the input data value array into the underlying byte stream, properly swapped and aligned. More...
 
int putData (FLTINT data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (FLTINT[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (FLTINT[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (NAME16FI[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (NAME16FI[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (NAME32DBLDBL[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (NAME32DBLDBL[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (INTINT data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (INTINT[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (INTINT[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (DBLDBL data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (DBLDBL[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (DBLDBL[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (DBLDBLDBL data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (DBLDBLDBL[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (DBLDBLDBL[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (String[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (String[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (KEYVALUE[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (KEYVALUE[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (String data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TTaggedStructure data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TTaggedStructure[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TTaggedStructure[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (byte[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (byte[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (byte value, int offset)
 Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (byte[] values, int offset)
 Puts the input data value array into the underlying byte stream, properly swapped and aligned. More...
 
int putData (IMAGE data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TCompoundDataObject data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TCompoundDataObject[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TCompoundDataObject[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (TCompoundDataObject value, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int getData (double[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (double[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int putData (double data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (double[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (double[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (double value, int offset)
 Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (double[] values, int offset)
 Puts the input data value array into the underlying byte stream, properly swapped and aligned. More...
 
int getData (long[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (long[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int putData (long data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (long[] data)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (long[] data, int length, int offset)
 Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned. More...
 
int putData (long value, int offset)
 Puts the input data value into the underlying byte stream, properly swapped and aligned. More...
 
int putData (long[] values, int offset)
 Puts the input data value array into the underlying byte stream, properly swapped and aligned. More...
 
int getArrayLength ()
 Returns the data array length of the associated tine Data Type object. More...
 
short getFormat ()
 Returns the data type of the associated tine Data Type object. More...
 
int getData (Object Data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (Object Data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
Object getDataObject ()
 Retrieves the returned data as an Object container. More...
 
Vector< Object > getVector ()
 Retrieves the returned data as a Vector. More...
 
String toString ()
 Outputs the returned data as a String. More...
 
 TDataType (char[] data)
 An array of chars (to be interpretted as a text string) More...
 
 TDataType (char[] data, int length)
 A subset of an array of chars (to be interpretted as a text string) More...
 
 TDataType (StringBuffer data)
 A text string buffer. More...
 
 TDataType (StringBuffer data, int length)
 A subset of a text string buffer. More...
 
 TDataType (String[] data)
 A subset of an array of Strings. More...
 
 TDataType (String[] data, int length)
 A subset of an array of Strings. More...
 
 TDataType (KEYVALUE[] data)
 A subset of an array of KEYVALUE Strings. More...
 
 TDataType (KEYVALUE[] data, int length)
 A subset of an array of KEYVALUE Strings. More...
 
 TDataType (String data)
 A text string. More...
 
 TDataType (String data, int length)
 A text string. More...
 
int getData (char[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (StringBuffer data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (String[] data)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getData (String[] data, int length, int offset)
 Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream. More...
 
int getCompletionLength ()
 Returns the last data completion length. More...
 

Static Public Member Functions

static long UnsignedInt (int ival)
 Converts a value transmitted as an 'unsigned' integer to a java signed long. More...
 
static int UnsignedInt (long lval)
 Forms an 'equivalent' unsigned integer for transmission. More...
 
static int UnsignedShort (short sval)
 Converts a value transmitted as an 'unsigned' short to a java signed integer. More...
 
static short UnsignedShort (int ival)
 Forms an 'equivalent' unsigned short for transmission. More...
 
static TDataType toTDataType (String text, String fmtstring)
 parse input string into a TDataType More...
 
static TDataType toTDataType (String text, short fmtcode)
 parse input string into a TDataType More...
 
static TDataType toTDataType (Object value)
 Create a TDataType object that contains the given value. More...
 

Detailed Description

TINE Data Type object All data transfered client <-> server must be contained in a TDataType object.

Furthermore all constructors of TDataType take an array of tine data types as input argument, i.e. a single element should be passed as an array of length 1

Constructor & Destructor Documentation

◆ TDataType() [1/33]

de.desy.tine.dataUtils.TDataType.TDataType ( int  dataSize,
short  dataFormat 
)

An unbound DataType object of the specified size and format.

Parameters
dataSizeis the array size of the given format.
dataFormatis the tine data type of the object to create.
Note
A call to getData() must be made in order to retrieve the incoming data into the application array parameters.

◆ TDataType() [2/33]

de.desy.tine.dataUtils.TDataType.TDataType ( byte[]  data)

A subset of an array of booleans.

This corresponds to tine format CF_BOOLEAN

Parameters
datais a reference to the boolean array used to create and bind to the TDataType object

◆ TDataType() [3/33]

de.desy.tine.dataUtils.TDataType.TDataType ( byte[]  data,
int  length 
)

A subset of an array of bytes.

Parameters
datais a reference to the byte array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [4/33]

de.desy.tine.dataUtils.TDataType.TDataType ( byte[]  data,
String  tag 
)

An array of 'structs' with the given tag or untagged structs if tag.length == 0 User-defined structures are allowed in tine and not too difficult to use.

It is strongly encouraged to make use of 'tagged' structures whereby the server and client both register the structure contents with the tine engine and apply a tag. Only then can issues of 'byte-swapping' and structure boundaries be handled correctly. As java does not have structures, the associated class is responsible for providing a toStruct() method which returns a byte stream containing the contents of the desired structure.

Parameters
datais a reference to the byte array stream containing the 'struct' used to create and bind to the TDataType object.
tagis the structure tag associated with the 'struct.'

◆ TDataType() [5/33]

de.desy.tine.dataUtils.TDataType.TDataType ( TTaggedStructure  data)

A Tagged Structure User-defined structures are allowed in tine and not too difficult to use.

It is strongly encouraged to make use of 'tagged' structures whereby the server and client both register the structure contents with the tine engine and apply a tag. Only then can issues of 'byte-swapping' and structure boundaries be handled correctly. As java does not have structures, the associated class is responsible for providing a toStruct() method which returns a byte stream containing the contents of the desired structure.

Parameters
datais a reference to a TTaggedStructure object.

References de.desy.tine.structUtils.TTaggedStructure.getName(), and de.desy.tine.structUtils.TTaggedStructure.getSizeInBytes().

◆ TDataType() [6/33]

de.desy.tine.dataUtils.TDataType.TDataType ( TTaggedStructure[]  data)

A array of Tagged Structures User-defined structures are allowed in tine and not too difficult to use.

It is strongly encouraged to make use of 'tagged' structures whereby the server and client both register the structure contents with the tine engine and apply a tag. Only then can issues of 'byte-swapping' and structure boundaries be handled correctly. As java does not have structures, the associated class is responsible for providing a toStruct() method which returns a byte stream containing the contents of the desired structure.

Parameters
datais a reference to an array of TTaggedStructure object.

References de.desy.tine.structUtils.TTaggedStructure.fixExtendedBytes(), de.desy.tine.structUtils.TTaggedStructure.getName(), and de.desy.tine.structUtils.TTaggedStructure.getSizeInBytes().

◆ TDataType() [7/33]

de.desy.tine.dataUtils.TDataType.TDataType ( short[]  data)

An array of shorts (2-byte integers) This corresponds to tine format CF_SHORT.

Parameters
datais a reference to the short array used to create and bind to the TDataType object

◆ TDataType() [8/33]

de.desy.tine.dataUtils.TDataType.TDataType ( short[]  data,
int  length 
)

A subset of an array of shorts (2-byte integers) This corresponds to tine format CF_SHORT.

Parameters
datais a reference to the short array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [9/33]

de.desy.tine.dataUtils.TDataType.TDataType ( short  data)

A single short value This method is only useful for quick creation of data 'down' objects (i.e.

data sets sent to the server). As there is no reference to the argument passed, it cannot be used to bind returning data to the object passed as the argument.

Parameters
datais a single short value used to create the TDataType object.

◆ TDataType() [10/33]

de.desy.tine.dataUtils.TDataType.TDataType ( int[]  data)

An array of ints (4-byte integers) This corresponds to tine format CF_LONG.

Parameters
datais a reference to the int array used to create and bind to the TDataType object

◆ TDataType() [11/33]

de.desy.tine.dataUtils.TDataType.TDataType ( int[]  data,
int  length 
)

A subset of an array of ints (4-byte integers) This corresponds to tine format CF_LONG.

Parameters
datais a reference to the int array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [12/33]

de.desy.tine.dataUtils.TDataType.TDataType ( boolean[]  data)

A subset of an array of booleans.

This corresponds to tine format CF_BOOLEAN

Parameters
datais a reference to the boolean array used to create and bind to the TDataType object

◆ TDataType() [13/33]

de.desy.tine.dataUtils.TDataType.TDataType ( boolean[]  data,
int  length 
)

A subset of an array of booleans.

This corresponds to tine format CF_BOOLEAN

Parameters
datais a reference to the boolean array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [14/33]

de.desy.tine.dataUtils.TDataType.TDataType ( float[]  data)

An array of floats This corresponds to tine format CF_FLOAT.

Parameters
datais a reference to the float array used to create and bind to the TDataType object

◆ TDataType() [15/33]

de.desy.tine.dataUtils.TDataType.TDataType ( float[]  data,
int  length 
)

A subset of an array of floats This corresponds to tine format CF_FLOAT.

Parameters
datais a reference to the float array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [16/33]

de.desy.tine.dataUtils.TDataType.TDataType ( TCompoundDataObject[]  data)

An array of tine data objects (e.g.

FLTINTs, FLTFLTs, NAME16s, etc.) can be bound to a tine data type object. Tine data type objects are used in data links between client and server.

Parameters
datais a reference to the data objects used to create and bind to the TDataType object

◆ TDataType() [17/33]

de.desy.tine.dataUtils.TDataType.TDataType ( TCompoundDataObject[]  data,
int  length 
)

An array of tine data objects (e.g.

FLTINTs, FLTFLTs, NAME16s, etc.) can be bound to a tine data type object. Tine data type objects are used in data links between client and server.

Parameters
datais a reference to the data objects used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [18/33]

de.desy.tine.dataUtils.TDataType.TDataType ( SPECTRUM  data)

A SPECTRUM object.

This corresponds to tine format CF_SPECTRUM

Parameters
datais a reference to the SPECTRUM object used to create and bind to the TDataType object

◆ TDataType() [19/33]

de.desy.tine.dataUtils.TDataType.TDataType ( IMAGE  data)

An IMAGE object.

This corresponds to tine format CF_IMAGE

Parameters
datais a reference to the IMAGE object used to create and bind to the TDataType object

References de.desy.tine.types.IMAGE.getImageFrameSize(), de.desy.tine.types.IMAGE.getSizeInBytes(), and de.desy.tine.types.IMAGE.toByteArray().

◆ TDataType() [20/33]

de.desy.tine.dataUtils.TDataType.TDataType ( double[]  data)

An array of doubles.

This corresponds to tine format CF_DOUBLE

Parameters
datais a reference to the double array used to create and bind to the TDataType object

◆ TDataType() [21/33]

de.desy.tine.dataUtils.TDataType.TDataType ( double[]  data,
int  length 
)

A subset of an array of doubles.

This corresponds to tine format CF_DOUBLE

Parameters
datais a reference to the double array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [22/33]

de.desy.tine.dataUtils.TDataType.TDataType ( long[]  data)

An array of (Java) longs.

This corresponds to tine format CF_DLONG or CF_INT64

Parameters
datais a reference to the long array used to create and bind to the TDataType object

◆ TDataType() [23/33]

de.desy.tine.dataUtils.TDataType.TDataType ( long[]  data,
int  length 
)

A subset of an array of (java) longs.

This corresponds to tine format CF_DLONG, CF_INT64

Parameters
datais a reference to the long array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [24/33]

de.desy.tine.dataUtils.TDataType.TDataType ( char[]  data)

An array of chars (to be interpretted as a text string)

Parameters
datais a reference to the char[] array used to create and bind to the TDataType object

◆ TDataType() [25/33]

de.desy.tine.dataUtils.TDataType.TDataType ( char[]  data,
int  length 
)

A subset of an array of chars (to be interpretted as a text string)

Parameters
datais a reference to the char[] array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [26/33]

de.desy.tine.dataUtils.TDataType.TDataType ( StringBuffer  data)

A text string buffer.

Parameters
datais a reference to the StringBuffer used to create and bind to the TDataType object

◆ TDataType() [27/33]

de.desy.tine.dataUtils.TDataType.TDataType ( StringBuffer  data,
int  length 
)

A subset of a text string buffer.

Parameters
datais a reference to the StringBuffer used to create and bind to the TDataType object
lengthis the subset length to use.

◆ TDataType() [28/33]

de.desy.tine.dataUtils.TDataType.TDataType ( String[]  data)

A subset of an array of Strings.

This corresponds to tine format CF_STRING

Parameters
datais a reference to the String array used to create and bind to the TDataType object

◆ TDataType() [29/33]

de.desy.tine.dataUtils.TDataType.TDataType ( String[]  data,
int  length 
)

A subset of an array of Strings.

This corresponds to tine format CF_STRING

Parameters
datais a reference to the String array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [30/33]

de.desy.tine.dataUtils.TDataType.TDataType ( KEYVALUE[]  data)

A subset of an array of KEYVALUE Strings.

This corresponds to tine format CF_KEYVALUE

Parameters
datais a reference to the String array used to create and bind to the TDataType object

◆ TDataType() [31/33]

de.desy.tine.dataUtils.TDataType.TDataType ( KEYVALUE[]  data,
int  length 
)

A subset of an array of KEYVALUE Strings.

This corresponds to tine format CF_KEYVALUE

Parameters
datais a reference to the KEYVALUE array used to create and bind to the TDataType object
lengthis the subset array length to use.

◆ TDataType() [32/33]

de.desy.tine.dataUtils.TDataType.TDataType ( String  data)

A text string.

Parameters
datais a reference to the String used to create and bind to the TDataType object

◆ TDataType() [33/33]

de.desy.tine.dataUtils.TDataType.TDataType ( String  data,
int  length 
)

A text string.

Parameters
datais a reference to the String used to create and bind to the TDataType object
lengthis the subset length to use.

Member Function Documentation

◆ getArrayDelimiter()

String de.desy.tine.dataUtils.TDataType.getArrayDelimiter ( )

Get the delimiter used in a string representation of an array.

Returns
the delimiter used in a string representation of an array

◆ getArrayLength()

int de.desy.tine.dataUtils.TDataType.getArrayLength ( )

Returns the data array length of the associated tine Data Type object.

Returns
Returns the data array length of the associated tine Data Type object

References de.desy.tine.definitions.TFormat.isAdjustableLength().

◆ getCompletionLength()

int de.desy.tine.dataUtils.TDataType.getCompletionLength ( )

◆ getData() [1/27]

int de.desy.tine.dataUtils.TDataType.getData ( )

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is mostly used internally, and is of little use to the API programmer.

Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getDataObject(), and de.desy.tine.structUtils.TTaggedStructure.getSizeInBytes().

Referenced by de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [2/27]

int de.desy.tine.dataUtils.TDataType.getData ( boolean[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [3/27]

int de.desy.tine.dataUtils.TDataType.getData ( boolean[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [4/27]

int de.desy.tine.dataUtils.TDataType.getData ( byte[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

Referenced by de.desy.tine.client.TLink.execute().

◆ getData() [5/27]

int de.desy.tine.dataUtils.TDataType.getData ( byte[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [6/27]

int de.desy.tine.dataUtils.TDataType.getData ( char[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [7/27]

int de.desy.tine.dataUtils.TDataType.getData ( double[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

◆ getData() [8/27]

int de.desy.tine.dataUtils.TDataType.getData ( double[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [9/27]

int de.desy.tine.dataUtils.TDataType.getData ( float[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [10/27]

int de.desy.tine.dataUtils.TDataType.getData ( float[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [11/27]

int de.desy.tine.dataUtils.TDataType.getData ( IMAGE  image)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.types.IMAGE.getImageFrameBuffer(), de.desy.tine.types.IMAGE.getImageFrameSize(), de.desy.tine.types.IMAGE.HEADER_SIZE, and de.desy.tine.types.IMAGE.readHeaders().

◆ getData() [12/27]

int de.desy.tine.dataUtils.TDataType.getData ( int[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [13/27]

int de.desy.tine.dataUtils.TDataType.getData ( int[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [14/27]

int de.desy.tine.dataUtils.TDataType.getData ( long[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

◆ getData() [15/27]

int de.desy.tine.dataUtils.TDataType.getData ( long[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [16/27]

int de.desy.tine.dataUtils.TDataType.getData ( Object  Data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

◆ getData() [17/27]

int de.desy.tine.dataUtils.TDataType.getData ( Object  Data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

◆ getData() [18/27]

int de.desy.tine.dataUtils.TDataType.getData ( short[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [19/27]

int de.desy.tine.dataUtils.TDataType.getData ( short[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [20/27]

int de.desy.tine.dataUtils.TDataType.getData ( SPECTRUM  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

◆ getData() [21/27]

int de.desy.tine.dataUtils.TDataType.getData ( String[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

◆ getData() [22/27]

int de.desy.tine.dataUtils.TDataType.getData ( String[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

◆ getData() [23/27]

int de.desy.tine.dataUtils.TDataType.getData ( StringBuffer  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf().

◆ getData() [24/27]

int de.desy.tine.dataUtils.TDataType.getData ( TCompoundDataObject[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [25/27]

int de.desy.tine.dataUtils.TDataType.getData ( TCompoundDataObject[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf(), de.desy.tine.types.TCompoundDataObject.getByteArray(), de.desy.tine.dataUtils.TDataType.getData(), de.desy.tine.types.TCompoundDataObject.getSizeInBytes(), de.desy.tine.types.TCompoundDataObject.toByteArray(), and de.desy.tine.types.TCompoundDataObject.toStruct().

◆ getData() [26/27]

int de.desy.tine.dataUtils.TDataType.getData ( TTaggedStructure[]  data)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData().

◆ getData() [27/27]

int de.desy.tine.dataUtils.TDataType.getData ( TTaggedStructure[]  data,
int  length,
int  offset 
)

Gets the canonical data set from the underlying data byte stream Gets the fully formed (properly assembled and byte-swapped) canonical data set from the underlying byte stream.

This method is used internally, but can be used to get the underlying data into the specifically referenced data, for instance when the TDataType object was instantiated with 'unbound' data.

Parameters
datais the data object into which the underlying data should be prepared and copied.
lengthis the number of elements to get
offsetis the beginning position of the target data array into which the data should be copied
Returns
0 on success or a tine error code

References de.desy.tine.dataUtils.TDataType.getData(), de.desy.tine.structUtils.TTaggedStructure.getName(), and de.desy.tine.structUtils.TTaggedStructure.getSizeInBytes().

◆ getDataObject()

Object de.desy.tine.dataUtils.TDataType.getDataObject ( )

Retrieves the returned data as an Object container.

This method is useful for obtaining the unbound data when the data type is unknown at link time. A call to getFormat() can be made to ascertain the tine data type and hence the array nature of the object returned.

Referenced by de.desy.tine.client.ez.TineClient.getAttributeClass(), de.desy.tine.dataUtils.TDataType.getData(), and de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

◆ getFormat()

short de.desy.tine.dataUtils.TDataType.getFormat ( )

Returns the data type of the associated tine Data Type object.

Returns
Returns the data type of the associated tine Data Type object

◆ getVector()

Vector<Object> de.desy.tine.dataUtils.TDataType.getVector ( )

Retrieves the returned data as a Vector.

This method is useful for obtaining the unbound data when the data type is unknown at link time. A call to getFormat() can be made to ascertain the tine data type and hence the contents of the Vector.

◆ putData() [1/63]

int de.desy.tine.dataUtils.TDataType.putData ( )

Puts the current canonical data set into the underlying data byte stream Puts the currently referenced canonical data set into the underlying byte stream, properly swapped and aligned.

This method is primarily used internally and is of little value to the API programmer.

Returns
0 upon success or a tine error code

Referenced by de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [2/63]

int de.desy.tine.dataUtils.TDataType.putData ( boolean  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [3/63]

int de.desy.tine.dataUtils.TDataType.putData ( boolean  value,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [4/63]

int de.desy.tine.dataUtils.TDataType.putData ( boolean[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [5/63]

int de.desy.tine.dataUtils.TDataType.putData ( boolean[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [6/63]

int de.desy.tine.dataUtils.TDataType.putData ( byte  value,
int  offset 
)

Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [7/63]

int de.desy.tine.dataUtils.TDataType.putData ( byte[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [8/63]

int de.desy.tine.dataUtils.TDataType.putData ( byte[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [9/63]

int de.desy.tine.dataUtils.TDataType.putData ( byte[]  values,
int  offset 
)

Puts the input data value array into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valuesis the values array which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [10/63]

int de.desy.tine.dataUtils.TDataType.putData ( DBLDBL  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [11/63]

int de.desy.tine.dataUtils.TDataType.putData ( DBLDBL[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [12/63]

int de.desy.tine.dataUtils.TDataType.putData ( DBLDBL[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [13/63]

int de.desy.tine.dataUtils.TDataType.putData ( DBLDBLDBL  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [14/63]

int de.desy.tine.dataUtils.TDataType.putData ( DBLDBLDBL[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [15/63]

int de.desy.tine.dataUtils.TDataType.putData ( DBLDBLDBL[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [16/63]

int de.desy.tine.dataUtils.TDataType.putData ( double  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [17/63]

int de.desy.tine.dataUtils.TDataType.putData ( double  value,
int  offset 
)

Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [18/63]

int de.desy.tine.dataUtils.TDataType.putData ( double[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [19/63]

int de.desy.tine.dataUtils.TDataType.putData ( double[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [20/63]

int de.desy.tine.dataUtils.TDataType.putData ( double[]  values,
int  offset 
)

Puts the input data value array into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valuesis the values array which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [21/63]

int de.desy.tine.dataUtils.TDataType.putData ( float  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [22/63]

int de.desy.tine.dataUtils.TDataType.putData ( float  value,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [23/63]

int de.desy.tine.dataUtils.TDataType.putData ( float[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [24/63]

int de.desy.tine.dataUtils.TDataType.putData ( float[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [25/63]

int de.desy.tine.dataUtils.TDataType.putData ( float[]  values,
int  offset 
)

Puts the input data value array into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valuesis the values array which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [26/63]

int de.desy.tine.dataUtils.TDataType.putData ( FLTINT  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [27/63]

int de.desy.tine.dataUtils.TDataType.putData ( FLTINT[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [28/63]

int de.desy.tine.dataUtils.TDataType.putData ( FLTINT[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [29/63]

int de.desy.tine.dataUtils.TDataType.putData ( IMAGE  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais IMAGE type whose contents are to copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.types.IMAGE.FrameHeader.appendedFrameSize, de.desy.tine.types.IMAGE.getFrameHeader(), de.desy.tine.types.IMAGE.getHeaderSize(), and de.desy.tine.types.IMAGE.getImageFrameSize().

◆ putData() [30/63]

int de.desy.tine.dataUtils.TDataType.putData ( int  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [31/63]

int de.desy.tine.dataUtils.TDataType.putData ( int  value,
int  offset 
)

Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [32/63]

int de.desy.tine.dataUtils.TDataType.putData ( int[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [33/63]

int de.desy.tine.dataUtils.TDataType.putData ( int[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [34/63]

int de.desy.tine.dataUtils.TDataType.putData ( int[]  values,
int  offset 
)

Puts the input data value array into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valuesis the values array which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [35/63]

int de.desy.tine.dataUtils.TDataType.putData ( INTINT  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [36/63]

int de.desy.tine.dataUtils.TDataType.putData ( INTINT[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [37/63]

int de.desy.tine.dataUtils.TDataType.putData ( INTINT[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [38/63]

int de.desy.tine.dataUtils.TDataType.putData ( KEYVALUE[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [39/63]

int de.desy.tine.dataUtils.TDataType.putData ( KEYVALUE[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [40/63]

int de.desy.tine.dataUtils.TDataType.putData ( long  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [41/63]

int de.desy.tine.dataUtils.TDataType.putData ( long  value,
int  offset 
)

Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [42/63]

int de.desy.tine.dataUtils.TDataType.putData ( long[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [43/63]

int de.desy.tine.dataUtils.TDataType.putData ( long[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [44/63]

int de.desy.tine.dataUtils.TDataType.putData ( long[]  values,
int  offset 
)

Puts the input data value array into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valuesis the values array which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [45/63]

int de.desy.tine.dataUtils.TDataType.putData ( NAME16FI[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [46/63]

int de.desy.tine.dataUtils.TDataType.putData ( NAME16FI[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [47/63]

int de.desy.tine.dataUtils.TDataType.putData ( NAME32DBLDBL[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [48/63]

int de.desy.tine.dataUtils.TDataType.putData ( NAME32DBLDBL[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [49/63]

int de.desy.tine.dataUtils.TDataType.putData ( short  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

Referenced by de.desy.tine.client.TLink.execute().

◆ putData() [50/63]

int de.desy.tine.dataUtils.TDataType.putData ( short  value,
int  offset 
)

Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [51/63]

int de.desy.tine.dataUtils.TDataType.putData ( short[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [52/63]

int de.desy.tine.dataUtils.TDataType.putData ( short[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.dataUtils.TDataType.putData().

◆ putData() [53/63]

int de.desy.tine.dataUtils.TDataType.putData ( short[]  values,
int  offset 
)

Puts the input data value array into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valuesis the values array which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

◆ putData() [54/63]

int de.desy.tine.dataUtils.TDataType.putData ( String  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [55/63]

int de.desy.tine.dataUtils.TDataType.putData ( String[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [56/63]

int de.desy.tine.dataUtils.TDataType.putData ( String[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [57/63]

int de.desy.tine.dataUtils.TDataType.putData ( TCompoundDataObject  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais data primitive whose value is copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.definitions.TFormat.formatSizeOf(), and de.desy.tine.types.TCompoundDataObject.getSizeInBytes().

◆ putData() [58/63]

int de.desy.tine.dataUtils.TDataType.putData ( TCompoundDataObject  value,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data value into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
valueis the single value which should be copied into the underlying byte stream and referenced data object at the given offset.
offsetis the position offset within the targeted array
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code
Exceptions
InputDataLockedExceptionif a link using this TDataType as input is bound to another link and an attempt to alter the input data set (which is part of the contract cached at the target server) is made.

References de.desy.tine.definitions.TFormat.isName(), de.desy.tine.definitions.TFormat.isNameInt(), and de.desy.tine.definitions.TFormat.toString().

◆ putData() [59/63]

int de.desy.tine.dataUtils.TDataType.putData ( TCompoundDataObject[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [60/63]

int de.desy.tine.dataUtils.TDataType.putData ( TCompoundDataObject[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the give data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [61/63]

int de.desy.tine.dataUtils.TDataType.putData ( TTaggedStructure  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais Tagged Structure whose contents are to be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

References de.desy.tine.structUtils.TTaggedStructure.fixExtendedBytes(), de.desy.tine.structUtils.TTaggedStructure.getName(), and de.desy.tine.structUtils.TTaggedStructure.getSizeInBytes().

◆ putData() [62/63]

int de.desy.tine.dataUtils.TDataType.putData ( TTaggedStructure[]  data)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ putData() [63/63]

int de.desy.tine.dataUtils.TDataType.putData ( TTaggedStructure[]  data,
int  length,
int  offset 
)

Puts the current canonical data set into the underlying data byte stream Puts the input data set into the underlying byte stream, properly swapped and aligned.

It replaces the contents of the original, referenced data array with that of the data object given.

Parameters
datais the data object whose contents should be copied into the underlying byte stream and referenced data object.
lengthis the number of elements from the given data object to copy
offsetis the starting offset within the array to copy
Note
If this TDataType object is used as input data in persistent links, then the data object might well be 'locked' meaning that the underlying data will NOT be changed, as this would constitute a change in contract.
Returns
0 upon success or a tine error code

◆ toString()

String de.desy.tine.dataUtils.TDataType.toString ( )

Outputs the returned data as a String.

This method is useful for displaying the unbound data when the data type is unknown at link time.

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

◆ toTDataType() [1/3]

static TDataType de.desy.tine.dataUtils.TDataType.toTDataType ( Object  value)
static

Create a TDataType object that contains the given value.

The data type is created based on the type of the given object, by calling one of the appropriate constructors.

Parameters
valuethe value to insert into the data type
Returns
data type

References de.desy.tine.dataUtils.TDataType.TDataType().

◆ toTDataType() [2/3]

static TDataType de.desy.tine.dataUtils.TDataType.toTDataType ( String  text,
short  fmtcode 
)
static

parse input string into a TDataType

Parameters
textis the text string which is to be parsed into data
fmtcodeis the TINE format code defining the parsing rules
Returns
a valid TDataType object or null if the input text cannot be parsed into a TDataType

References de.desy.tine.dataUtils.TDataType.toTDataType().

◆ toTDataType() [3/3]

static TDataType de.desy.tine.dataUtils.TDataType.toTDataType ( String  text,
String  fmtstring 
)
static

parse input string into a TDataType

Parameters
textis the text string which is to be parsed into data
fmtstringis the TINE format code (in string representation) defining the parsing rules
Returns
a valid TDataType object or null if the input text cannot be parsed into a TDataType

References de.desy.tine.definitions.TFormat.getFormatCode().

Referenced by de.desy.tine.dataUtils.TDataType.toTDataType().

◆ UnsignedInt() [1/2]

static long de.desy.tine.dataUtils.TDataType.UnsignedInt ( int  ival)
static

Converts a value transmitted as an 'unsigned' integer to a java signed long.

Parameters
ivalan encoded unsigned integer value
Returns
the corresponding java signed long

◆ UnsignedInt() [2/2]

static int de.desy.tine.dataUtils.TDataType.UnsignedInt ( long  lval)
static

Forms an 'equivalent' unsigned integer for transmission.

Parameters
lvala java long value (signed) to be encoded as an unsigned integer
Returns
the encoded unsigned integer

◆ UnsignedShort() [1/2]

static short de.desy.tine.dataUtils.TDataType.UnsignedShort ( int  ival)
static

Forms an 'equivalent' unsigned short for transmission.

Parameters
ivala java integer value (signed) to be encoded as an unsigned short
Returns
the encoded unsigned short

◆ UnsignedShort() [2/2]

static int de.desy.tine.dataUtils.TDataType.UnsignedShort ( short  sval)
static

Converts a value transmitted as an 'unsigned' short to a java signed integer.

Parameters
svalan encoded unsigned short value
Returns
the corresponding java signed integer

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