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

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

List of all members.

Public Member Functions
	TPropertyDescription (String prpDescription)
	Constructs a TPropertyDescription.
	TPropertyDescription (short newArrayType, int newArrayRowLength, int newNumRows)
	Constructs a TPropertyDescription.
	TPropertyDescription (String prpDescription, short newArrayType, int newArrayRowLength, int newNumRows)
	Constructs a TPropertyDescription.
	TPropertyDescription ()
	Constructs a TPropertyDescription.
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

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.

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)

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)

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

(

)

Constructs a TPropertyDescription.

---

Member Function Documentation

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

(

)

Returns:

Returns the arrayNumRows.

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

(

)

Returns:

Returns the arrayRowLength.

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

(

)

Returns:

Returns the arrayType.

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

(

)

Returns:

Returns the redirection.

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

(

)

Returns:

Returns the description.

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

(

)

Returns:

Returns the xUnits.

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

(

)

Returns:

Returns the yUnits.

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>]"

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

(

int

arrayNumRows

)

Parameters:

arrayNumRows

The arrayNumRows to set.

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

(

int

arrayRowLength

)

Parameters:

arrayRowLength

The arrayRowLength to set.

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

(

short

arrayType

)

Parameters:

arrayType

The arrayType to set.

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

(

String

redirection

)

Parameters:

redirection

The redirection to set.

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

(

String

description

)

Parameters:

description

The description text to set.

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

(

TPropertyEGU

egu

)

Parameters:

egu	The horizontal egu to set.

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

(

TPropertyEGU

egu

)

Parameters:

egu	The vertical egu to set.

---

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

• TPropertyDescription.java