Tms::PuProcess Class Reference

This interface provides functions to configure and capture data from individual pick-up. More...

#include <TmsC.h>

Inheritance diagram for Tms::PuProcess:

BoapClientObject BSocket BSocket

List of all members.

Public Member Functions

 PuProcess (BString name="")
BError getVersion (BString &version)
 Gets the software version.
BError getCycleInformation (UInt32 cycleNumber, CycleInformation &cycleInformation)
 Gets information on given cycle number.
BError getStatus (PuChannel puChannel, PuStatus &puStatus)
BError getData (PuChannel puChannel, DataInfo dataInfo, Data &data)
 This function returns a set of data from the data present in the data cache or directly from the Pick-Up processing engines. The DataInfo object describes the data required. The call will return the required data along with an error object indicating success or an error condition as appropriate. The call will block until data is ready.
BError addEventServer (BString name)
 Adds an event server.
BError requestData (PuChannel puChannel, DataInfo dataInfo)
 This adds a request for some data. The DataInfo object defines the data required. This request can be made at any time. If the data is present in cache the data will be available immediately, if not the system will await the data from a subsequent processing cycle. When the data is available a "data" event will be sent to the client. Not that it is not necessary to use requestData. The client can call getData() directly although this call will block until the data is actually ready.


Detailed Description

This interface provides functions to configure and capture data from individual pick-up.

Constructor & Destructor Documentation

Tms::PuProcess::PuProcess ( BString  name = ""  ) 


Member Function Documentation

BError Tms::PuProcess::getVersion ( BString version  ) 

Gets the software version.

BError Tms::PuProcess::getCycleInformation ( UInt32  cycleNumber,
CycleInformation cycleInformation 
)

Gets information on given cycle number.

BError Tms::PuProcess::getStatus ( PuChannel  puChannel,
PuStatus puStatus 
)

BError Tms::PuProcess::getData ( PuChannel  puChannel,
DataInfo  dataInfo,
Data data 
)

This function returns a set of data from the data present in the data cache or directly from the Pick-Up processing engines. The DataInfo object describes the data required. The call will return the required data along with an error object indicating success or an error condition as appropriate. The call will block until data is ready.

BError Tms::PuProcess::addEventServer ( BString  name  ) 

Adds an event server.

BError Tms::PuProcess::requestData ( PuChannel  puChannel,
DataInfo  dataInfo 
)

This adds a request for some data. The DataInfo object defines the data required. This request can be made at any time. If the data is present in cache the data will be available immediately, if not the system will await the data from a subsequent processing cycle. When the data is available a "data" event will be sent to the client. Not that it is not necessary to use requestData. The client can call getData() directly although this call will block until the data is actually ready.


The documentation for this class was generated from the following files:
Generated on Tue Jan 22 09:32:41 2008 for LibTmsApi by  doxygen 1.5.4