Main Page | Features | Central Services | csv-Files | Types | Transfer | Access | API-C | API-VB/ActiveX | API-Java | Examples | Downloads
Public Member Functions | Protected Member Functions
de.desy.tine.server.properties.TPropertyHandler Class Reference

An abstract handler for property requests. More...

List of all members.

Public Member Functions

final int callHandler (String devName, TDataType dout, TDataType din, TAccess devAccess)
 Public interface for call().

Protected Member Functions

abstract int call (String devName, TDataType dout, TDataType din, TAccess devAccess)
 The method which handles all property requests.

Detailed Description

An abstract handler for property requests.

When a client requests access for a certain property, the equipment module calls that property's handler. A property handler has to implement the abstract method call().


Member Function Documentation

abstract int de.desy.tine.server.properties.TPropertyHandler.call ( String  devName,
TDataType  dout,
TDataType  din,
TAccess  devAccess 
) [protected, pure virtual]

The method which handles all property requests.

This method must be implemented by derived classes.

Parameters:
devNameDevice name.
doutOutput data buffer.
dinInput data buffer.
devAccessAccess specification.
Returns:
0 or some TErrorList constant.
final int de.desy.tine.server.properties.TPropertyHandler.callHandler ( String  devName,
TDataType  dout,
TDataType  din,
TAccess  devAccess 
)

Public interface for call().

Verifies parameters and calls the abstract method call(). This method is called by the equipment module.

Parameters:
devNameDevice name.
doutOutput data buffer.
dinInput data buffer.
devAccessAccess specification.
Returns:
Returns illegal_format if dout/din are null while the corresponding access is requested. Returns code_failure if an exception occurs in call(). Redirects the return value of call() otherwise. TODO change short devAccess to TAccess devAccess (See TAccess)

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