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

Device servers must export the properties they wish to handle. More...

Public Member Functions
void	setRunInSeparateThread (boolean value)
	Establishes whether a handler for this property is to be called in its own thread or not. More...
void	setDeviceList (ArrayList< String > deviceList)
	Sets the property's device list to the ArrayList given.
ArrayList< String >	getDeviceList ()
	Returns the property's device list.
	TExportProperty (int prpId, String prpName, short accessMode, TDataType din, TDataType dout, String prpDescription)
	Constructor. More...
	TExportProperty (String prpName, short accessMode, TDataType din, TDataType dout, String prpDescription)
	Constructor. More...
	TExportProperty (String prpName, int outputSize, short outputFormat)
	Constructor. More...
	TExportProperty (String prpName, int outputSize, short outputFormat, int inputSize, short inputFormat)
	Constructor. More...
	TExportProperty (int prpId, String prpName, short accessMode, TDataType din, TDataType dout)
	Constructor. More...
	TExportProperty (TExportProperty source)
	A Copy Constructor. More...
	TExportProperty (int prpId, String prpName, String prpDescription, int prpSizeOut, short prpFormatOut, String prpTagOut, int prpSizeIn, short prpFormatIn, String prpTagIn, short access)
	Constructor. More...
	TExportProperty (String prpName, String prpDescription, int prpSizeOut, short prpFormatOut, String prpTagOut, int prpSizeIn, short prpFormatIn, String prpTagIn, short access)
	Constructor. More...
	TExportProperty (int prpId, String prpName, TPropertyDescription prpDescription, int prpSizeOut, short prpFormatOut, String prpTagOut, int prpSizeIn, short prpFormatIn, String prpTagIn, short access)
	Constructor. More...
	TExportProperty (String prpName, TPropertyDescription prpDescription, int prpSizeOut, short prpFormatOut, String prpTagOut, int prpSizeIn, short prpFormatIn, String prpTagIn, short access)
	Constructor. More...
	TExportProperty (int prpId, String prpName, String prpDescription, int prpSizeOut, short prpFormatOut, int prpSizeIn, short prpFormatIn, short access)
	Constructor. More...
	TExportProperty (String prpName, String prpDescription, int prpSizeOut, short prpFormatOut, int prpSizeIn, short prpFormatIn, short access)
	Constructor. More...
	TExportProperty (int prpId, String prpName, String prpDescription, int prpSizeOut, short prpFormatOut)
	Constructor. More...
short	getAccessMode ()
void	setAccessMode (short accessMode)
String	getAlias ()
void	setAlias (String alias)
int	getId ()
void	setId (int id)
short	getInputFormat ()
void	setInputFormat (short inputFormat)
int	getInputSize ()
void	setInputSize (int inputSize)
String	getInputTag ()
void	setInputTag (String inputTag)
String	getName ()
void	setName (String name)
short	getOutputFormat ()
void	setOutputFormat (short outputFormat)
int	getOutputSize ()
void	setOutputSize (int outputSize)
String	getOutputTag ()
void	setOutputTag (String outputTag)
TPropertyDescription	getDescription ()
void	setDescription (TPropertyDescription description)

Detailed Description

Device servers must export the properties they wish to handle.

Author

duval

Constructor & Destructor Documentation

TExportProperty() [1/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	int	prpId,
		String	prpName,
		short	accessMode,
		TDataType	din,
		TDataType	dout,
		String	prpDescription
	)

Constructor.

Creates a property with an ID.

Parameters

prpId	The property identifier
prpName	The property name.
accessMode	The access mode associating with the property (CA_READ and/or CA_WRITE).
din	Specifies input format information
dout	Specifies output format information
prpDscr	gives a property description.

TExportProperty() [2/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	String	prpName,
		short	accessMode,
		TDataType	din,
		TDataType	dout,
		String	prpDescription
	)

Constructor.

Creates a property with the given settings.

Parameters

prpName	The property name.
accessMode	The access mode associating with the property (CA_READ and/or CA_WRITE).
din	Specifies input format information
dout	Specifies output format information
prpDscr	gives a property description.

TExportProperty() [3/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	String	prpName,
		int	outputSize,
		short	outputFormat
	)

Constructor.

Creates a TExportProperty for read access.

Parameters

prpName
outputSize
outputFormat

TExportProperty() [4/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	String	prpName,
		int	outputSize,
		short	outputFormat,
		int	inputSize,
		short	inputFormat
	)

Constructor.

Creates a TExportProperty for read/write access.

Parameters

prpName
outputSize
outputFormat
inputSize
inputFormat

TExportProperty() [5/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	int	prpId,
		String	prpName,
		short	accessMode,
		TDataType	din,
		TDataType	dout
	)

Constructor.

Creates a property with an ID.

Parameters

prpId	The property identifier
prpName	The property name.
accessMode	The access mode associating with the property (CA_READ and/or CA_WRITE).
din	Specifies input format information
dout	Specifies output format information

TExportProperty() [6/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty

(

TExportProperty

source

)

A Copy Constructor.

NOTE: This implementation SIMULATES a copy constructor. It does not copy everything. Useful only for TStockProperty, alias properties !!!.

Parameters

source

References de.desy.tine.server.properties.TPropertyDescription.getText().

TExportProperty() [7/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	int	prpId,
		String	prpName,
		String	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut,
		String	prpTagOut,
		int	prpSizeIn,
		short	prpFormatIn,
		String	prpTagIn,
		short	access
	)

Constructor.

Creates a property with an ID.

Parameters

prpId	The property identifier
prpName	The property name.
prpDescription	gives a property description string.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format
prpTagOut	gives the property's output data tag
prpSizeIn	gives the property's input size
prpFormatIn	gives the property's input format
prpTagIn	gives the property's input data tag
access	gives the property's access mode

TExportProperty() [8/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	String	prpName,
		String	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut,
		String	prpTagOut,
		int	prpSizeIn,
		short	prpFormatIn,
		String	prpTagIn,
		short	access
	)

Constructor.

Creates a property with given settings.

Parameters

prpName	The property name.
prpDescription	gives a property description string.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format
prpTagOut	gives the property's output data tag
prpSizeIn	gives the property's input size
prpFormatIn	gives the property's input format
prpTagIn	gives the property's input data tag
access	gives the property's access mode

TExportProperty() [9/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	int	prpId,
		String	prpName,
		TPropertyDescription	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut,
		String	prpTagOut,
		int	prpSizeIn,
		short	prpFormatIn,
		String	prpTagIn,
		short	access
	)

Constructor.

Creates a property with an ID.

Parameters

prpId	The property identifier
prpName	The property name.
prpDescription	gives a property description object.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format
prpTagOut	gives the property's output data tag
prpSizeIn	gives the property's input size
prpFormatIn	gives the property's input format
prpTagIn	gives the property's input data tag
access	gives the property's access mode

TExportProperty() [10/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	String	prpName,
		TPropertyDescription	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut,
		String	prpTagOut,
		int	prpSizeIn,
		short	prpFormatIn,
		String	prpTagIn,
		short	access
	)

Constructor.

Creates a property with given settings.

Parameters

prpName	The property name.
prpDescription	gives a property description object.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format
prpTagOut	gives the property's output data tag
prpSizeIn	gives the property's input size
prpFormatIn	gives the property's input format
prpTagIn	gives the property's input data tag
access	gives the property's access mode

TExportProperty() [11/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	int	prpId,
		String	prpName,
		String	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut,
		int	prpSizeIn,
		short	prpFormatIn,
		short	access
	)

Constructor.

Creates a property with an ID.

Parameters

prpId	The property identifier
prpName	The property name.
prpDescription	gives a property description.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format
prpSizeIn	gives the property's input size
prpFormatIn	gives the property's input format
access	gives the property's access mode

TExportProperty() [12/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	String	prpName,
		String	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut,
		int	prpSizeIn,
		short	prpFormatIn,
		short	access
	)

Constructor.

Creates a property with given settings.

Parameters

prpName	The property name.
prpDescription	gives a property description.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format
prpSizeIn	gives the property's input size
prpFormatIn	gives the property's input format
access	gives the property's access mode

TExportProperty() [13/13]

de.desy.tine.server.properties.TExportProperty.TExportProperty	(	int	prpId,
		String	prpName,
		String	prpDescription,
		int	prpSizeOut,
		short	prpFormatOut
	)

Constructor.

Creates a property with an ID.

Parameters

prpId	The property identifier
prpName	The property name.
prpDescription	gives a property description.
prpSizeOut	gives the property's output size
prpFormatOut	gives the property's output format

Member Function Documentation

getAccessMode()

short de.desy.tine.server.properties.TExportProperty.getAccessMode

(

)

Returns

Returns the accessMode.

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

getAlias()

String de.desy.tine.server.properties.TExportProperty.getAlias

(

)

Returns

Returns the alias.

getDescription()

TPropertyDescription de.desy.tine.server.properties.TExportProperty.getDescription

(

)

Returns

Returns the description.

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

getId()

int de.desy.tine.server.properties.TExportProperty.getId

(

)

Returns

Returns the id.

getInputFormat()

short de.desy.tine.server.properties.TExportProperty.getInputFormat

(

)

Returns

Returns the inputFormat.

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

getInputSize()

int de.desy.tine.server.properties.TExportProperty.getInputSize

(

)

Returns

Returns the inputSize.

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

getInputTag()

String de.desy.tine.server.properties.TExportProperty.getInputTag

(

)

Returns

Returns the inputTag.

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

getName()

String de.desy.tine.server.properties.TExportProperty.getName

(

)

Returns

Returns the name.

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

getOutputFormat()

short de.desy.tine.server.properties.TExportProperty.getOutputFormat

(

)

Returns

Returns the numOverloads.

Parameters

numOverloads

The numOverloads to set.

Returns

Returns the outputFormat.

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

getOutputSize()

int de.desy.tine.server.properties.TExportProperty.getOutputSize

(

)

Returns

Returns the outputSize.

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

getOutputTag()

String de.desy.tine.server.properties.TExportProperty.getOutputTag

(

)

Returns

Returns the outputTag.

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

setAccessMode()

void de.desy.tine.server.properties.TExportProperty.setAccessMode

(

short

accessMode

)

Parameters

accessMode

The accessMode to set.

References de.desy.tine.definitions.TAccess.isRead(), and de.desy.tine.definitions.TAccess.isWrite().

setAlias()

void de.desy.tine.server.properties.TExportProperty.setAlias

(

String

alias

)

Parameters

alias

The alias to set.

setDescription()

void de.desy.tine.server.properties.TExportProperty.setDescription

(

TPropertyDescription

description

)

Parameters

description

The description to set.

References de.desy.tine.server.properties.TPropertyDescription.getArrayNumRows(), de.desy.tine.server.properties.TPropertyDescription.getArrayType(), de.desy.tine.server.properties.TPropertyDescription.getText(), de.desy.tine.server.properties.TPropertyDescription.getXRange(), de.desy.tine.server.properties.TPropertyDescription.getYRange(), de.desy.tine.server.properties.TPropertyDescription.setArrayNumRows(), de.desy.tine.server.properties.TPropertyDescription.setArrayType(), de.desy.tine.server.properties.TPropertyDescription.setText(), de.desy.tine.server.properties.TPropertyDescription.setXRange(), and de.desy.tine.server.properties.TPropertyDescription.setYRange().

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

setId()

void de.desy.tine.server.properties.TExportProperty.setId

(

int

id

)

Parameters

id	The id to set.

setInputFormat()

void de.desy.tine.server.properties.TExportProperty.setInputFormat

(

short

inputFormat

)

Parameters

inputFormat

The inputFormat to set.

setInputSize()

void de.desy.tine.server.properties.TExportProperty.setInputSize

(

int

inputSize

)

Parameters

inputSize

The inputSize to set.

setInputTag()

void de.desy.tine.server.properties.TExportProperty.setInputTag

(

String

inputTag

)

Parameters

inputTag

The inputTag to set.

setName()

void de.desy.tine.server.properties.TExportProperty.setName

(

String

name

)

Parameters

name	The name to set.

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

setOutputFormat()

void de.desy.tine.server.properties.TExportProperty.setOutputFormat

(

short

outputFormat

)

Parameters

outputFormat

The outputFormat to set.

setOutputSize()

void de.desy.tine.server.properties.TExportProperty.setOutputSize

(

int

outputSize

)

Parameters

outputSize

The outputSize to set.

setOutputTag()

void de.desy.tine.server.properties.TExportProperty.setOutputTag

(

String

outputTag

)

Parameters

outputTag

The outputTag to set.

setRunInSeparateThread()

void de.desy.tine.server.properties.TExportProperty.setRunInSeparateThread

(

boolean

value

)

Establishes whether a handler for this property is to be called in its own thread or not.

Parameters

value

is the desired setting.

---

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

• TExportProperty.java