de.desy.tine.server.properties.TPropertyDescription Class Reference

Provides meta information about an exported property. More...

Public Member Functions
	TPropertyDescription (String prpDescription)
	Constructs a TPropertyDescription. More...
	TPropertyDescription (short newArrayType, int newArrayRowLength, int newNumRows)
	Constructs a TPropertyDescription. More...
	TPropertyDescription (String prpDescription, short newArrayType, int newArrayRowLength, int newNumRows)
	Constructs a TPropertyDescription. More...
	TPropertyDescription (String prpDescription, TPropertyEGU yRange, TPropertyEGU xRange, short newArrayType, int newArrayRowLength, int newNumRows)
	Constructs a TPropertyDescription. More...
	TPropertyDescription (String prpDescription, String units, float minValue, float maxValue)
	Constructs a TPropertyDescription for a property representing a scalar attribute. More...
	TPropertyDescription ()
	Constructs a default TPropertyDescription. More...
TPropertyEGU	getXRange ()
void	setXRange (TPropertyEGU egu)
TPropertyEGU	getYRange ()
void	setYRange (TPropertyEGU egu)
String	getText ()
void	setText (String description)
String	getRedirection ()
void	setRedirection (String redirection)
int	getArrayNumRows ()
void	setArrayNumRows (int arrayNumRows)
int	getArrayRowLength ()
void	setArrayRowLength (int arrayRowLength)
short	getArrayType ()
void	setArrayType (short arrayType)
void	parseComplexString (String parseableDescription)

Detailed Description

Provides meta information about an exported property.

Author

duval

Constructor & Destructor Documentation

TPropertyDescription() [1/6]

de.desy.tine.server.properties.TPropertyDescription.TPropertyDescription

(

String

prpDescription

)

Constructs a TPropertyDescription.

This constructor only establishes the text description of the property

Parameters

prpDescription

is a string description of the property.

TPropertyDescription() [2/6]

de.desy.tine.server.properties.TPropertyDescription.TPropertyDescription	(	short	newArrayType,
		int	newArrayRowLength,
		int	newNumRows
	)

Constructs a TPropertyDescription.

Parameters

newArrayType	is the array type of the property
newArrayRowLength	is the row length (for multiply dimensioned properties)
newNumRows	is the number of rows (for multiply dimensioned properties)

TPropertyDescription() [3/6]

de.desy.tine.server.properties.TPropertyDescription.TPropertyDescription	(	String	prpDescription,
		short	newArrayType,
		int	newArrayRowLength,
		int	newNumRows
	)

Constructs a TPropertyDescription.

Parameters

prpDescription	is a string description of the property.
newArrayType	is the array type of the property
newArrayRowLength	is the row length (for multiply dimensioned properties)
newNumRows	is the number of rows (for multiply dimensioned properties)

TPropertyDescription() [4/6]

de.desy.tine.server.properties.TPropertyDescription.TPropertyDescription	(	String	prpDescription,
		TPropertyEGU	yRange,
		TPropertyEGU	xRange,
		short	newArrayType,
		int	newArrayRowLength,
		int	newNumRows
	)

Constructs a TPropertyDescription.

Parameters

prpDescription	is a string description of the property.
yRange	is the (nominal) vertical axis engineering units and range object
xRange	is the horizontal axis engineering units and range object
newArrayType	is the array type of the property
newArrayRowLength	is the row length (for multiply dimensioned properties)
newNumRows	is the number of rows (for multiply dimensioned properties)

TPropertyDescription() [5/6]

de.desy.tine.server.properties.TPropertyDescription.TPropertyDescription	(	String	prpDescription,
		String	units,
		float	minValue,
		float	maxValue
	)

Constructs a TPropertyDescription for a property representing a scalar attribute.

Parameters

prpDescription	is a string description of the property.
units	is the engineering units
minValue	is the minimum value
maxValue	is the maximum value

TPropertyDescription() [6/6]

de.desy.tine.server.properties.TPropertyDescription.TPropertyDescription

(

)

Constructs a default TPropertyDescription.

Member Function Documentation

getArrayNumRows()

int de.desy.tine.server.properties.TPropertyDescription.getArrayNumRows

(

)

Returns

Returns the arrayNumRows.

Referenced by de.desy.tine.server.properties.TExportProperty.setDescription(), and de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

getArrayRowLength()

int de.desy.tine.server.properties.TPropertyDescription.getArrayRowLength

(

)

Returns

Returns the arrayRowLength.

Referenced by de.desy.tine.server.equipment.TEquipmentModule.registerProperty(), and de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

getArrayType()

short de.desy.tine.server.properties.TPropertyDescription.getArrayType

(

)

Returns

Returns the arrayType.

Referenced by de.desy.tine.server.equipment.TEquipmentModule.addAlarmWatchTableEntry(), de.desy.tine.server.equipment.TEquipmentModule.addLocalHistoryRecord(), de.desy.tine.server.properties.TExportProperty.setDescription(), and de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

getRedirection()

String de.desy.tine.server.properties.TPropertyDescription.getRedirection

(

)

Returns

Returns the redirection.

Referenced by de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

getText()

String de.desy.tine.server.properties.TPropertyDescription.getText

(

)

Returns

Returns the description.

Referenced by de.desy.tine.server.properties.TExportProperty.setDescription(), de.desy.tine.server.properties.TExportProperty.TExportProperty(), and de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

getXRange()

TPropertyEGU de.desy.tine.server.properties.TPropertyDescription.getXRange

(

)

Returns

Returns the xUnits.

Referenced by de.desy.tine.server.properties.TPropertyDescription.parseComplexString(), de.desy.tine.server.properties.TExportProperty.setDescription(), and de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

getYRange()

TPropertyEGU de.desy.tine.server.properties.TPropertyDescription.getYRange

(

)

Returns

Returns the yUnits.

Referenced by de.desy.tine.server.properties.TPropertyDescription.parseComplexString(), de.desy.tine.server.properties.TExportProperty.setDescription(), and de.desy.tine.queryUtils.TPropertyQuery.TPropertyQuery().

parseComplexString()

void de.desy.tine.server.properties.TPropertyDescription.parseComplexString

(

String

parseableDescription

)

Parameters

parseableDescription

A property description string of the form (legacy) "[ymin:ymax yegu][xmin:xmax xegu]<description>" or (modern) "[vscale=ymin:ymax yegu][hscale=xmin:xmax xegu][vplot=lin/log][url=...] [desc=<description>]"

References de.desy.tine.server.properties.TPropertyDescription.getXRange(), de.desy.tine.server.properties.TPropertyDescription.getYRange(), de.desy.tine.server.properties.TPropertyDescription.setText(), de.desy.tine.server.properties.TPropertyDescription.setXRange(), and de.desy.tine.server.properties.TPropertyDescription.setYRange().

setArrayNumRows()

void de.desy.tine.server.properties.TPropertyDescription.setArrayNumRows

(

int

arrayNumRows

)

Parameters

arrayNumRows

The arrayNumRows to set.

Referenced by de.desy.tine.server.properties.TExportProperty.setDescription().

setArrayRowLength()

void de.desy.tine.server.properties.TPropertyDescription.setArrayRowLength

(

int

arrayRowLength

)

Parameters

arrayRowLength

The arrayRowLength to set.

Referenced by de.desy.tine.server.equipment.TEquipmentModule.registerProperty().

setArrayType()

void de.desy.tine.server.properties.TPropertyDescription.setArrayType

(

short

arrayType

)

Parameters

arrayType

The arrayType to set.

Referenced by de.desy.tine.server.equipment.TEquipmentModule.registerProperty(), and de.desy.tine.server.properties.TExportProperty.setDescription().

setRedirection()

void de.desy.tine.server.properties.TPropertyDescription.setRedirection

(

String

redirection

)

Parameters

redirection

The redirection to set.

setText()

void de.desy.tine.server.properties.TPropertyDescription.setText

(

String

description

)

Parameters

description

The description text to set.

Referenced by de.desy.tine.server.properties.TPropertyDescription.parseComplexString(), and de.desy.tine.server.properties.TExportProperty.setDescription().

setXRange()

void de.desy.tine.server.properties.TPropertyDescription.setXRange

(

TPropertyEGU

egu

)

Parameters

egu	The horizontal egu to set.

Referenced by de.desy.tine.server.properties.TPropertyDescription.parseComplexString(), and de.desy.tine.server.properties.TExportProperty.setDescription().

setYRange()

void de.desy.tine.server.properties.TPropertyDescription.setYRange

(

TPropertyEGU

egu

)

Parameters

egu	The vertical egu to set.

Referenced by de.desy.tine.server.properties.TPropertyDescription.parseComplexString(), and de.desy.tine.server.properties.TExportProperty.setDescription().

---

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

• TPropertyDescription.java