tine.TDataType Class Reference

TINE Data Type object: All data transfered client between and server must be contained in a TDataType object. More...

Public Member Functions
String[]	GetChannelNames ()
	Returns an array of strings providing suitable channel name labels according to the current data object More...
Int32	GetData (Object data)
	Gets the data from the underlying data object and assigns it to the object given More...
Int32	GetData (Object data, int length, int offset)
	Gets the data from the underlying data object and assigns it to the object given More...
Int32	GetData (ref double data)
	Gets the data from the underlying data object and assigns it to the referenced double More...
Int32	GetData (ref float data)
	Gets the data from the underlying data object and assigns it to the referenced float More...
Int32	GetData (ref Int16 data)
	Gets the data from the underlying data object and assigns it to the referenced signed short More...
Int32	GetData (ref Int32 data)
	Gets the data from the underlying data object and assigns it to the referenced signed int More...
Int32	GetData (ref UInt16 data)
	Gets the data from the underlying data object and assigns it to the referenced unsigned signed short More...
Int32	GetData (ref UInt32 data)
	Gets the data from the underlying data object and assigns it to the referenced unsigned int More...
String[]	GetDataAsStringArray ()
	Returns an array of strings representing the current data object More...
int	GetDataFormat ()
	Gets the tine data format assigned to the underlying data. More...
string	GetDataTag ()
	Gets the data tag assigned to the underlying data. (e.g. structure or bitfield tag). More...
double	GetDataTimeStamp ()
	Gets the current data timestamp (as a UTC double) associated with the underlying data. More...
Int32	GetSystemStamp ()
	Gets the current system stamp (e.g. event/cycle number) associated with the underlying data. More...
Int32	PutData ()
	assigns the referenced data object to the underlying TDatatype data object More...
Int32	PutData (DIMAGE data)
	assigns the input DIMAGE data to the underlying TDatatype data object More...
Int32	PutData (Object data)
	assigns the input data object to the underlying TDatatype data object More...
Int32	PutData (Object data, int length, int offset)
	assigns the input data object to the underlying TDatatype data object More...
Int32	PutData (Object data, int row, int length, int offset)
	assigns the input (double array) data object to the underlying TDatatype data object More...
void	SetDataArrayLength (UInt32 len)
	Assigns the given array length to the underlying data. More...
void	SetDataTag (string tag)
	Sets the data tag assigned to the underlying data. (e.g. structure or bitfield tag). More...
void	SetDataTimeStamp (double timestamp)
	Sets the current data timestamp (as a UTC double) to the underlying data. More...
void	SetSystemStamp (Int32 sysStamp)
	Sets the current system stamp to the underlying data. More...
	TDataType ()
	Makes a CF_NULL TDataType More...
	TDataType (Array data)
	Makes a TDataType from the array object given More...
	TDataType (Array data, int offset, int length)
	Makes a TDataType from the array object given More...
unsafe	TDataType (DIMAGE[] data)
	makes a TDataType from the DIMAGE array More...
	TDataType (int dataSize, byte dataFmt, string dataTag)
	Makes a new TDataType based on the parameters given More...
	TDataType (Object data)
	makes a TDataType from the .NET object passed More...
unsafe	TDataType (ref DBLDBL data)
	makes a TDataType from the referenced DBLDBL More...
unsafe	TDataType (ref DIMAGE data)
	makes a TDataType from the referenced DIMAGE More...
unsafe	TDataType (ref double data)
	makes a TDataType from the referenced double passed More...
unsafe	TDataType (ref DUSTRING data)
	makes a TDataType from the referenced DUSTRING More...
unsafe	TDataType (ref float data)
	makes a TDataType from the referenced float passed More...
unsafe	TDataType (ref FLTFLT data)
	makes a TDataType from the referenced FLTFLT More...
unsafe	TDataType (ref FLTFLTINT data)
	makes a TDataType from the referenced FLTFLTINT More...
unsafe	TDataType (ref FLTINT data)
	makes a TDataType from the referenced FLTINT More...
unsafe	TDataType (ref FLTINTINT data)
	makes a TDataType from the referenced FLTINTINT More...
unsafe	TDataType (ref Int16 data)
	makes a TDataType from the referenced signed short More...
unsafe	TDataType (ref Int32 data)
	makes a TDataType from the referenced signed int More...
unsafe	TDataType (ref Int64 data)
	makes a TDataType from the referenced signed long More...
unsafe	TDataType (ref INTFLTINT data)
	makes a TDataType from the referenced INTFLTINT More...
unsafe	TDataType (ref INTINT data)
	makes a TDataType from the referenced INTINT More...
unsafe	TDataType (ref INTINTINTINT data)
	makes a TDataType from the referenced INTINTINTINT More...
unsafe	TDataType (ref NAME16 data)
	makes a TDataType from the referenced NAME16 More...
unsafe	TDataType (ref NAME16FI data)
	makes a TDataType from the referenced NAMEFI More...
unsafe	TDataType (ref NAME16I data)
	makes a TDataType from the referenced NAME16I More...
unsafe	TDataType (ref NAME32 data)
	makes a TDataType from the referenced NAME32 More...
unsafe	TDataType (ref NAME32DBLDBL data)
	makes a TDataType from the referenced NAME32DBLDBL More...
unsafe	TDataType (ref NAME32I data)
	makes a TDataType from the referenced NAME32I More...
unsafe	TDataType (ref NAME64 data)
	makes a TDataType from the referenced NAME64 More...
unsafe	TDataType (ref NAME64DBL data)
	makes a TDataType from the referenced NAME64DBL More...
unsafe	TDataType (ref NAME64DBLDBL data)
	makes a TDataType from the referenced NAME64DBLDBL More...
unsafe	TDataType (ref NAME64I data)
	makes a TDataType from the referenced NAME64I More...
unsafe	TDataType (ref NAME8 data)
	makes a TDataType from the referenced NAME8 More...
unsafe	TDataType (ref UInt16 data)
	makes a TDataType from the referenced unigned short More...
unsafe	TDataType (ref UInt32 data)
	makes a TDataType from the referenced unsigned int More...
unsafe	TDataType (ref UInt64 data)
	makes a TDataType from the referenced unsigned long More...

Static Public Member Functions
static String[]	GetChannelNames (Object data)
	Returns an array of strings providing suitable channel name labels according to the data object passed. More...
static String[]	GetChannelNames (Object data, int len)
	Returns an array of strings providing suitable channel name labels according to the data object passed. More...
static String	GetDataAsString (Object data)
	Returns a string representing the given data object More...
static String[]	GetDataAsStringArray (Object data)
	Returns an array of strings representing the given data object More...
static String[]	GetDataAsStringArray (Object data, int precision)
	Returns an array of strings representing the given data object More...
static String[]	GetDataAsStringArray (Object data, int precision, Boolean primaryValueOnly)
	Returns an array of strings representing the given data object More...
static String	GetDelimiter ()
	Gets the string separation to use when the 'ToString' method of compound data types is used. More...
static byte	GetTineFormat (Object data)
	gets the TINE data format code for the object passed More...
static byte	GetTineFormat (Type type)
	gets the TINE data format code for the Type passed More...
static double[]	GetXAxis (Object data)
	Returns an array of double values suitable for use as the X-axis values in a plot More...
static double[]	GetXAxis (Object data, int len)
	Returns an array of double values suitable for use as the X-axis values in a plot More...
static double[]	GetYAxis (Object data)
	Returns an array of double values suitable for use as the Y-axis values in a plot More...
static double[]	GetYAxis (Object data, int len)
	Returns an array of double values suitable for use as the Y-axis values in a plot More...
static object	MakeDataObject (ushort fmt, int siz)
	Makes a data (array) object of the given type of the given array size and tine format More...
static object	MakeDataObject (ushort fmt, int siz, String tag)
	Makes a data (array) object of the given type of the given array size and tine format More...
static void	SetDelimiter (String value)
	Sets the string separation to use when the 'ToString' method of compound data types is used. More...

Detailed Description

TINE Data Type object: All data transfered client between and server must be contained in a TDataType object.

Constructor & Destructor Documentation

TDataType() [1/35]

unsafe tine.TDataType.TDataType ( ref double  data )

inline

makes a TDataType from the referenced double passed

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [2/35]

unsafe tine.TDataType.TDataType ( ref float  data )

inline

makes a TDataType from the referenced float passed

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [3/35]

unsafe tine.TDataType.TDataType ( ref UInt16  data )

inline

makes a TDataType from the referenced unigned short

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [4/35]

unsafe tine.TDataType.TDataType ( ref Int16  data )

inline

makes a TDataType from the referenced signed short

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [5/35]

unsafe tine.TDataType.TDataType ( ref UInt32  data )

inline

makes a TDataType from the referenced unsigned int

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [6/35]

unsafe tine.TDataType.TDataType ( ref Int32  data )

inline

makes a TDataType from the referenced signed int

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [7/35]

unsafe tine.TDataType.TDataType ( ref UInt64  data )

inline

makes a TDataType from the referenced unsigned long

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [8/35]

unsafe tine.TDataType.TDataType ( ref Int64  data )

inline

makes a TDataType from the referenced signed long

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [9/35]

unsafe tine.TDataType.TDataType ( ref NAME64  data )

inline

makes a TDataType from the referenced NAME64

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [10/35]

unsafe tine.TDataType.TDataType ( ref NAME32  data )

inline

makes a TDataType from the referenced NAME32

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [11/35]

unsafe tine.TDataType.TDataType ( ref NAME16  data )

inline

makes a TDataType from the referenced NAME16

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [12/35]

unsafe tine.TDataType.TDataType ( ref NAME8  data )

inline

makes a TDataType from the referenced NAME8

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [13/35]

unsafe tine.TDataType.TDataType ( ref FLTINT  data )

inline

makes a TDataType from the referenced FLTINT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [14/35]

unsafe tine.TDataType.TDataType ( ref INTINT  data )

inline

makes a TDataType from the referenced INTINT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [15/35]

unsafe tine.TDataType.TDataType ( ref FLTFLT  data )

inline

makes a TDataType from the referenced FLTFLT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [16/35]

unsafe tine.TDataType.TDataType ( ref DBLDBL  data )

inline

makes a TDataType from the referenced DBLDBL

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [17/35]

unsafe tine.TDataType.TDataType ( ref NAME64I  data )

inline

makes a TDataType from the referenced NAME64I

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [18/35]

unsafe tine.TDataType.TDataType ( ref NAME64DBL  data )

inline

makes a TDataType from the referenced NAME64DBL

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [19/35]

unsafe tine.TDataType.TDataType ( ref NAME32I  data )

inline

makes a TDataType from the referenced NAME32I

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [20/35]

unsafe tine.TDataType.TDataType ( ref NAME16I  data )

inline

makes a TDataType from the referenced NAME16I

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [21/35]

unsafe tine.TDataType.TDataType ( ref NAME16FI  data )

inline

makes a TDataType from the referenced NAMEFI

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [22/35]

unsafe tine.TDataType.TDataType ( ref NAME64DBLDBL  data )

inline

makes a TDataType from the referenced NAME64DBLDBL

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [23/35]

unsafe tine.TDataType.TDataType ( ref NAME32DBLDBL  data )

inline

makes a TDataType from the referenced NAME32DBLDBL

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [24/35]

unsafe tine.TDataType.TDataType ( ref INTFLTINT  data )

inline

makes a TDataType from the referenced INTFLTINT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [25/35]

unsafe tine.TDataType.TDataType ( ref FLTFLTINT  data )

inline

makes a TDataType from the referenced FLTFLTINT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [26/35]

unsafe tine.TDataType.TDataType ( ref FLTINTINT  data )

inline

makes a TDataType from the referenced FLTINTINT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [27/35]

unsafe tine.TDataType.TDataType ( ref INTINTINTINT  data )

inline

makes a TDataType from the referenced INTINTINTINT

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [28/35]

unsafe tine.TDataType.TDataType ( ref DUSTRING  data )

inline

makes a TDataType from the referenced DUSTRING

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [29/35]

unsafe tine.TDataType.TDataType ( DIMAGE[]  data )

inline

makes a TDataType from the DIMAGE array

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

References tine.DIMAGE.header.

TDataType() [30/35]

unsafe tine.TDataType.TDataType ( ref DIMAGE  data )

inline

makes a TDataType from the referenced DIMAGE

Parameters

data	a reference to the the scalar object which should be bound to the TDataType

TDataType() [31/35]

tine.TDataType.TDataType ( Object  data )

inline

makes a TDataType from the .NET object passed

Parameters

data	the .NET object which should be bound to the TDataType

TDataType() [32/35]

tine.TDataType.TDataType ( )

inline

Makes a CF_NULL TDataType

TDataType() [33/35]

tine.TDataType.TDataType ( Array  data )

inline

Makes a TDataType from the array object given

Parameters

data	the (array) object used to construct this TDataType

TDataType() [34/35]

tine.TDataType.TDataType ( Array  data, int  offset, int  length  )

inline

Makes a TDataType from the array object given

Parameters

data	the (array) object used to construct this TDataType
offset	the offset in the array object to use as the beginning of the underlying data object
length	the length of the array object (following the offset) to use in the beginning of the underlying data object

TDataType() [35/35]

tine.TDataType.TDataType ( int  dataSize, byte  dataFmt, string  dataTag  )

inline

Makes a new TDataType based on the parameters given

Parameters

dataSize	the desired size (array length) of the data object
dataFmt	the tine format of the data object
dataTag	the structure or bitfielt tag of the data object

Member Function Documentation

GetChannelNames() [1/3]

String [] tine.TDataType.GetChannelNames ( )

inline

Returns an array of strings providing suitable channel name labels according to the current data object

Returns

an array of strings providing suitable channel name labels

Referenced by tine.TDataType.GetChannelNames().

GetChannelNames() [2/3]

static String [] tine.TDataType.GetChannelNames ( Object  data )

inlinestatic

Returns an array of strings providing suitable channel name labels according to the data object passed.

Parameters

data	an array of data of a tine-recognized type

Returns

an array of strings providing suitable channel name labels

References tine.TDataType.GetChannelNames().

GetChannelNames() [3/3]

static String [] tine.TDataType.GetChannelNames ( Object  data, int  len  )

inlinestatic

Returns an array of strings providing suitable channel name labels according to the data object passed.

Parameters

data	an array of data of a tine-recognized type
len	the length of the data array to use in making the new data object

Returns

an array of strings providing suitable channel name labels

GetData() [1/8]

Int32 tine.TDataType.GetData ( Object  data )

inline

Gets the data from the underlying data object and assigns it to the object given

Parameters

data	the object which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

References tine.TDataType.GetData(), and tine.TDataType.PutData().

GetData() [2/8]

Int32 tine.TDataType.GetData ( Object  data, int  length, int  offset  )

inline

Gets the data from the underlying data object and assigns it to the object given

Parameters

data	the object which should contain the data value when the call successfully completes
length	the (array) length of data to extract from the underlying data
offset	the (array) offset into which the underlying data should be updated.

Returns

0 upon success or a tine error code

GetData() [3/8]

Int32 tine.TDataType.GetData ( ref double  data )

inline

Gets the data from the underlying data object and assigns it to the referenced double

Parameters

data	a reference to the double which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

GetData() [4/8]

Int32 tine.TDataType.GetData ( ref float  data )

inline

Gets the data from the underlying data object and assigns it to the referenced float

Parameters

data	a reference to the float which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

GetData() [5/8]

Int32 tine.TDataType.GetData ( ref Int16  data )

inline

Gets the data from the underlying data object and assigns it to the referenced signed short

Parameters

data	a reference to the signed short which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

Referenced by tine.TDataType.GetData().

GetData() [6/8]

Int32 tine.TDataType.GetData ( ref Int32  data )

inline

Gets the data from the underlying data object and assigns it to the referenced signed int

Parameters

data	a reference to the signed int which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

GetData() [7/8]

Int32 tine.TDataType.GetData ( ref UInt16  data )

inline

Gets the data from the underlying data object and assigns it to the referenced unsigned signed short

Parameters

data	a reference to the unsigned short which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

GetData() [8/8]

Int32 tine.TDataType.GetData ( ref UInt32  data )

inline

Gets the data from the underlying data object and assigns it to the referenced unsigned int

Parameters

data	a reference to the unsigned int which should contain the data value when the call successfully completes

Returns

0 upon success or a tine error code

GetDataAsString()

static String tine.TDataType.GetDataAsString ( Object  data )

inlinestatic

Returns a string representing the given data object

Parameters

data	a tine-recognized type

Returns

a string representing the given data object

Referenced by tine.TDataType.GetDataAsStringArray().

GetDataAsStringArray() [1/4]

String [] tine.TDataType.GetDataAsStringArray ( )

inline

Returns an array of strings representing the current data object

Returns

an array of strings representing the current data object

Referenced by tine.TDataType.GetDataAsStringArray().

GetDataAsStringArray() [2/4]

static String [] tine.TDataType.GetDataAsStringArray ( Object  data )

inlinestatic

Returns an array of strings representing the given data object

Parameters

data	an array of data of a tine-recognized type

Returns

an array of strings representing the given data object

References tine.TDataType.GetDataAsStringArray().

GetDataAsStringArray() [3/4]

static String [] tine.TDataType.GetDataAsStringArray ( Object  data, int  precision  )

inlinestatic

Returns an array of strings representing the given data object

Parameters

data	an array of data of a tine-recognized type
precision	the precision to use in forming a string array from floating point data

Returns

an array of strings representing the given data object

References tine.TDataType.GetDataAsStringArray().

GetDataAsStringArray() [4/4]

static String [] tine.TDataType.GetDataAsStringArray ( Object  data, int  precision, Boolean  primaryValueOnly  )

inlinestatic

Returns an array of strings representing the given data object

Parameters

data	an array of data of a tine-recognized type
precision	the precision to use in forming a string array from floating point data
primaryValueOnly	if 'true' then compound data type will return only their canonical or primary string value

Returns

an array of strings representing the given data object

References tine.TDataType.GetDataAsString().

GetDataFormat()

int tine.TDataType.GetDataFormat ( )

inline

Gets the tine data format assigned to the underlying data.

Returns

the tine data format

Referenced by tine.TKernel.RegisterPropertyInformation().

GetDataTag()

string tine.TDataType.GetDataTag ( )

inline

Gets the data tag assigned to the underlying data. (e.g. structure or bitfield tag).

Returns

the data tag assigned to the underlying data

Referenced by tine.TKernel.RegisterPropertyInformation().

GetDataTimeStamp()

double tine.TDataType.GetDataTimeStamp ( )

inline

Gets the current data timestamp (as a UTC double) associated with the underlying data.

Returns

the current data timestamp (as a UTC double) associated with the underlying data

Referenced by tine.TTrace.GetTraceSequence().

GetDelimiter()

static String tine.TDataType.GetDelimiter ( )

inlinestatic

Gets the string separation to use when the 'ToString' method of compound data types is used.

Returns

the separation string

GetSystemStamp()

Int32 tine.TDataType.GetSystemStamp ( )

inline

Gets the current system stamp (e.g. event/cycle number) associated with the underlying data.

Returns

the current system stamp associated with the underlying data

GetTineFormat() [1/2]

static byte tine.TDataType.GetTineFormat ( Object  data )

inlinestatic

gets the TINE data format code for the object passed

Parameters

data	is the data object whose TINE data format is desired.

Returns

the TINE data format code assigned to the object specified

Referenced by tine.TDataType.GetXAxis(), and tine.TDataType.GetYAxis().

GetTineFormat() [2/2]

static byte tine.TDataType.GetTineFormat ( Type  type )

inlinestatic

gets the TINE data format code for the Type passed

Parameters

type	is the .NET Type whose TINE data format is desired.

Returns

the TINE data format code assigned to the object specified

GetXAxis() [1/2]

static double [] tine.TDataType.GetXAxis ( Object  data )

inlinestatic

Returns an array of double values suitable for use as the X-axis values in a plot

Parameters

data	an array of data of a tine-recognized type

Returns

an array of double values suitable for use as the X-axis values in a plot

References tine.TDataType.GetXAxis().

Referenced by tine.TDataType.GetXAxis().

GetXAxis() [2/2]

static double [] tine.TDataType.GetXAxis ( Object  data, int  len  )

inlinestatic

Returns an array of double values suitable for use as the X-axis values in a plot

Parameters

data	an array of data of a tine-recognized type
len	the length of the data array to use in making the new data object

Returns

an array of double values suitable for use as the X-axis values in a plot

References tine.TDataType.GetTineFormat(), and tine.TDataType.GetXAxis().

GetYAxis() [1/2]

static double [] tine.TDataType.GetYAxis ( Object  data )

inlinestatic

Returns an array of double values suitable for use as the Y-axis values in a plot

Parameters

data	an array of data of a tine-recognized type

Returns

an array of double values suitable for use as the Y-axis values in a plot

References tine.TDataType.GetYAxis().

Referenced by tine.TDataType.GetYAxis().

GetYAxis() [2/2]

static double [] tine.TDataType.GetYAxis ( Object  data, int  len  )

inlinestatic

Returns an array of double values suitable for use as the Y-axis values in a plot

Parameters

data	an array of data of a tine-recognized type
len	the length of the data array to use in making the new data object

Returns

an array of double values suitable for use as the Y-axis values in a plot

References tine.TDataType.GetTineFormat().

MakeDataObject() [1/2]

static object tine.TDataType.MakeDataObject ( ushort  fmt, int  siz  )

inlinestatic

Makes a data (array) object of the given type of the given array size and tine format

Parameters

fmt	the tine format code used to define the data type
siz	the array length of the data object

Returns

a data (array) object of the given type of the given array size and tine format

MakeDataObject() [2/2]

static object tine.TDataType.MakeDataObject ( ushort  fmt, int  siz, String  tag  )

inlinestatic

Makes a data (array) object of the given type of the given array size and tine format

Parameters

fmt	the tine format code used to define the data type
siz	the array length of the data object
tag	the (registered) structure tag to use in making the data type (if format = 'CF_STRUCT')

Returns

a data (array) object of the given type of the given array size and tine format

PutData() [1/5]

Int32 tine.TDataType.PutData ( )

inline

assigns the referenced data object to the underlying TDatatype data object

Returns

0 upon success or a tine error code

Referenced by tine.TDataType.GetData(), and tine.TDataType.PutData().

PutData() [2/5]

Int32 tine.TDataType.PutData ( DIMAGE  data )

inline

assigns the input DIMAGE data to the underlying TDatatype data object

Parameters

data	the DIMAGE data which to be assigned to the underlying data object

Returns

0 upon success or a tine error code

PutData() [3/5]

Int32 tine.TDataType.PutData ( Object  data )

inline

assigns the input data object to the underlying TDatatype data object

Parameters

data	the data object which to be assigned to the underlying TDatatype data object

Returns

References tine.TDataType.PutData().

PutData() [4/5]

Int32 tine.TDataType.PutData ( Object  data, int  length, int  offset  )

inline

assigns the input data object to the underlying TDatatype data object

Parameters

data	the data object (array) which to be assigned to the underlying TDatatype data object
length	the length of the input object array to assign to the TDataType object
offset	the offset of the input array elements which should assigned to the TDataType object

Returns

0 upon success or a tine error code

Example:

  // relevant initialization snippet ...
  
  float[,] sinbuf = new float[NUM_DEVICES,NUM_VALUES];
  SineInfo[] sineInfoTable = new SineInfo[NUM_DEVICES];
    
  myeqm = new TEquipmentModule("DotNetSine", "DNTEQM", 10, sineqm, sinini, sinbkg, 1000, sinexi);
 
  TDataType dtout = new TDataType(8192,Formats.CF_FLOAT,null);
 
  myeqm.RegisterPropertyInformation("Sine", dtout, null, Access.CA_READ, ArrayType.AT_TRACE, 8192, "[-512:512 V]Sine Curve", PRP_SINE, "");
  dtout = new TDataType(10, Formats.CF_FLOAT, null);
 
  TDataType dtin = new TDataType(1, Formats.CF_FLOAT, null);
  myeqm.RegisterPropertyInformation("Amplitude", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[-512:512 V]Sine Curve Amplitude", PRP_AMPLITUDE, "");
  myeqm.RegisterPropertyInformation("Frequency", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[1:20 Hz]Sine Curve Frequency", PRP_FREQUENCY, "");
  myeqm.RegisterPropertyInformation("Phase", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:6.28]Sine curve Phase", PRP_PHASE, "");
  myeqm.RegisterPropertyInformation("Noise", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:50 V]Sine curve Noise", PRP_NOISE, "");
 
 
  // handling property requests ...
 
  public Int32 sineqm(string dev, string prp, TDataType dout, TDataType din, UInt16 acc,TEquipmentModule eqm)
  {
    float fval = 0;
    float[] mcarray = new float[NUM_DEVICES];
    int cc;
    int devnr = eqm.GetDeviceNumber(dev, prp);
    int prpid = eqm.GetPropertyId(prp); 
    switch (prpid)
    {
      case PRP_SINE:
        if ((acc & Access.CA_WRITE) != 0) return Errors.illegal_read_write;
        if ((cc = dout.PutData(sinbuf,devnr,NUM_VALUES,0)) != 0) return cc;
        return 0;
      case PRP_AMPLITUDE:
        if (din.GetDataArrayLength() > 0)
        if (din.GetDataArrayLength() > 0)
        { // input data => require write access
          if ((acc & Access.CA_WRITE) != Access.CA_WRITE) return Errors.illegal_read_write;
          if ((cc = din.GetData(ref fval)) != 0) return cc;
          if (fval < 1 || fval > 1000) return Errors.out_of_range;
          sineInfoTable[devnr].amplitude = fval;
        }
        if (dout.GetDataArrayLength() > 0)
        { // prepare multichannel array
          for (int i = 0; i < NUM_DEVICES; i++)
            mcarray[i] = sineInfoTable[i].amplitude;
          if ((cc = dout.PutData(mcarray,NUM_DEVICES,devnr)) != 0) return cc;
        }
        return 0;
      case PRP_FREQUENCY:
        // etc.

PutData() [5/5]

Int32 tine.TDataType.PutData ( Object  data, int  row, int  length, int  offset  )

inline

assigns the input (double array) data object to the underlying TDatatype data object

Parameters

data	the data object (as a double array) which to be assigned to the underlying TDatatype data object
row	the specific rou of the double array to assign to the TDataType object
length	the length of the input object array to assign to the TDataType object
offset	the offset of the input array elements which should assigned to the TDataType object

Returns

0 upon success or a tine error code

Example:

  // relevant initialization snippet ...
  
  float[,] sinbuf = new float[NUM_DEVICES,NUM_VALUES];
  SineInfo[] sineInfoTable = new SineInfo[NUM_DEVICES];
    
  myeqm = new TEquipmentModule("DotNetSine", "DNTEQM", 10, sineqm, sinini, sinbkg, 1000, sinexi);
 
  TDataType dtout = new TDataType(8192,Formats.CF_FLOAT,null);
 
  myeqm.RegisterPropertyInformation("Sine", dtout, null, Access.CA_READ, ArrayType.AT_TRACE, 8192, "[-512:512 V]Sine Curve", PRP_SINE, "");
  dtout = new TDataType(10, Formats.CF_FLOAT, null);
 
  TDataType dtin = new TDataType(1, Formats.CF_FLOAT, null);
  myeqm.RegisterPropertyInformation("Amplitude", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[-512:512 V]Sine Curve Amplitude", PRP_AMPLITUDE, "");
  myeqm.RegisterPropertyInformation("Frequency", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[1:20 Hz]Sine Curve Frequency", PRP_FREQUENCY, "");
  myeqm.RegisterPropertyInformation("Phase", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:6.28]Sine curve Phase", PRP_PHASE, "");
  myeqm.RegisterPropertyInformation("Noise", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:50 V]Sine curve Noise", PRP_NOISE, "");
 
 
  // handling property requests ...
 
  public Int32 sineqm(string dev, string prp, TDataType dout, TDataType din, UInt16 acc,TEquipmentModule eqm)
  {
    float fval = 0;
    float[] mcarray = new float[NUM_DEVICES];
    int cc;
    int devnr = eqm.GetDeviceNumber(dev, prp);
    int prpid = eqm.GetPropertyId(prp); 
    switch (prpid)
    {
      case PRP_SINE:
        if ((acc & Access.CA_WRITE) != 0) return Errors.illegal_read_write;
        if ((cc = dout.PutData(sinbuf,devnr,NUM_VALUES,0)) != 0) return cc;
        return 0;
      case PRP_AMPLITUDE:
        if (din.GetDataArrayLength() > 0)
        if (din.GetDataArrayLength() > 0)
        { // input data => require write access
          if ((acc & Access.CA_WRITE) != Access.CA_WRITE) return Errors.illegal_read_write;
          if ((cc = din.GetData(ref fval)) != 0) return cc;
          if (fval < 1 || fval > 1000) return Errors.out_of_range;
          sineInfoTable[devnr].amplitude = fval;
        }
        if (dout.GetDataArrayLength() > 0)
        { // prepare multichannel array
          for (int i = 0; i < NUM_DEVICES; i++)
            mcarray[i] = sineInfoTable[i].amplitude;
          if ((cc = dout.PutData(mcarray,NUM_DEVICES,devnr)) != 0) return cc;
        }
        return 0;
      case PRP_FREQUENCY:
        // etc.

SetDataArrayLength()

void tine.TDataType.SetDataArrayLength ( UInt32  len )

inline

Assigns the given array length to the underlying data.

Parameters

len	the desired array length

SetDataTag()

void tine.TDataType.SetDataTag ( string  tag )

inline

Sets the data tag assigned to the underlying data. (e.g. structure or bitfield tag).

Parameters

tag	the data tag to assign to the underlying data

SetDataTimeStamp()

void tine.TDataType.SetDataTimeStamp ( double  timestamp )

inline

Sets the current data timestamp (as a UTC double) to the underlying data.

Parameters

timestamp

the (UTC double) timestamp to associate with the underlying data

SetDelimiter()

static void tine.TDataType.SetDelimiter ( String  value )

inlinestatic

Sets the string separation to use when the 'ToString' method of compound data types is used.

Parameters

value

the desired separation string

SetSystemStamp()

void tine.TDataType.SetSystemStamp ( Int32  sysStamp )

inline

Sets the current system stamp to the underlying data.

Parameters

sysStamp

the stamp (cycle/event number) to associate with the underlying data

---

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

• tine.cs