de.desy.tine.definitions.TArrayType Class Reference

Data set returned by a call to a property can specify the type of array it is by registering this information. More...

Public Member Functions
String	toString ()
	Returns the string representation of this array type. More...
short	getValue ()
	Returns the value. More...
boolean	isChannel ()
	Return true if this array type presents multi-channel array. More...
boolean	isScalar ()
	Return true if this array type presents scalar value. More...
boolean	isVector ()
	Return true if property returns a single dimensioned array (i.e. More...
boolean	isTrace ()
	Return true if property returns a trace array. More...
boolean	isMatrix ()
	Return true if property returns a double dimensioned array (a matrix). More...

Static Public Member Functions
static String	toString (short type)
	Returns the string representation of the input array type. More...
static short	getType (String typeString)
static TArrayType	valueOf (short val)
	Return new instance of TArrayType object. More...
static boolean	isChannel (int arrayType)
	Return true if input arrayType returns a multi-channel array. More...
static boolean	isScalar (int arrayType)
	Returns true if the array type presents scalar value. More...
static boolean	isVector (int arrayType)
	Return true if input arrayType returns a single dimensioned array (i.e. More...
static boolean	isTrace (int arrayType)
	Return true if input arrayType returns a trace array. More...
static boolean	isMatrix (int arrayType)
	Return true if input arrayType returns a double dimensioned array (a matrix). More...

Detailed Description

Data set returned by a call to a property can specify the type of array it is by registering this information.

Author

duval

Member Function Documentation

getType()

static short de.desy.tine.definitions.TArrayType.getType ( String  typeString )

static

Parameters

typeString

is an array type string

Returns

the numerical form of the array type

Referenced by de.desy.tine.definitions.TFormat.getFormatArrayType().

getValue()

short de.desy.tine.definitions.TArrayType.getValue

(

)

Returns the value.

Returns

Returns the value.

isChannel() [1/2]

boolean de.desy.tine.definitions.TArrayType.isChannel

(

)

Return true if this array type presents multi-channel array.

Returns

true if this array type presents multi-channel array.

isChannel() [2/2]

static boolean de.desy.tine.definitions.TArrayType.isChannel ( int  arrayType )

static

Return true if input arrayType returns a multi-channel array.

Parameters

arrayType

is the targeted array type.

Returns

true if input arrayType returns a multi-channel array

isMatrix() [1/2]

boolean de.desy.tine.definitions.TArrayType.isMatrix

(

)

Return true if property returns a double dimensioned array (a matrix).

Returns

true if property returns a double dimensioned array (a matrix).

isMatrix() [2/2]

static boolean de.desy.tine.definitions.TArrayType.isMatrix ( int  arrayType )

static

Return true if input arrayType returns a double dimensioned array (a matrix).

Parameters

arrayType

is the targeted array type.

Returns

true if input arrayType returns a double dimensioned array (a matrix).

isScalar() [1/2]

boolean de.desy.tine.definitions.TArrayType.isScalar

(

)

Return true if this array type presents scalar value.

Returns

true if this array type presents scalar value.

isScalar() [2/2]

static boolean de.desy.tine.definitions.TArrayType.isScalar ( int  arrayType )

static

Returns true if the array type presents scalar value.

Parameters

arrayType

is the array type to be examined

Returns

true if the array type presents scalar value.

isTrace() [1/2]

boolean de.desy.tine.definitions.TArrayType.isTrace

(

)

Return true if property returns a trace array.

Returns

true if property returns a trace array

isTrace() [2/2]

static boolean de.desy.tine.definitions.TArrayType.isTrace ( int  arrayType )

static

Return true if input arrayType returns a trace array.

Parameters

arrayType

is the targeted array type.

Returns

true if input arrayType returns a trace array

isVector() [1/2]

boolean de.desy.tine.definitions.TArrayType.isVector

(

)

Return true if property returns a single dimensioned array (i.e.

a vector).

Returns

true if property returns a single dimensioned array (i.e. a vector).

isVector() [2/2]

static boolean de.desy.tine.definitions.TArrayType.isVector ( int  arrayType )

static

Return true if input arrayType returns a single dimensioned array (i.e.

a vector).

Parameters

arrayType

is the targeted array type.

Returns

true if input arrayType returns a single dimensioned array (i.e. a vector).

toString() [1/2]

String de.desy.tine.definitions.TArrayType.toString

(

)

Returns the string representation of this array type.

Returns

the string representation of this array type

toString() [2/2]

static String de.desy.tine.definitions.TArrayType.toString ( short  type )

static

Returns the string representation of the input array type.

Parameters

type	is the array type for which the string representation is desired

Returns

the string representation of the input array type

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

valueOf()

static TArrayType de.desy.tine.definitions.TArrayType.valueOf ( short  val )

static

Return new instance of TArrayType object.

Parameters

val	raw type value

Returns

new instance

---

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

• TArrayType.java