Tms::TmsProcess Class Reference

This interface provides functions to capture data from the TMS as a whole. More...

#include <TmsC.h>

Inheritance diagram for Tms::TmsProcess:

BoapClientObject BSocket BSocket List of all members.

Public Member Functions

 TmsProcess (BString name="")
BError getVersion (BString &version)
 Gets the software version.
BError getCycleInfo (UInt32 &cycleNumber, BString &cycleType)
 Gets the current cycle number and type.
BError getData (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)
 This call adds an event server to call on events such as the "dataEvent" generated by the requestData(0 call as well as error events. The Client will use this to notify the TmsServer of its local TmsEvent object.
BError requestData (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 capture data from the TMS as a whole.


Constructor & Destructor Documentation

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

Parameters:
name The name of the TmsProcess BOAP object to connect to.
The BOAP object name has the general form: "//HostName/ObjectName"


Member Function Documentation

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

Gets the software version.

Parameters:
version A string variable filled in with the version number string.

BError Tms::TmsProcess::getCycleInfo ( UInt32 cycleNumber,
BString cycleType 
)

Gets the current cycle number and type.

Parameters:
cycleNumber The current cycle number is returned here
cycleType The current cycle type is returned here.

BError Tms::TmsProcess::getData ( 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.

Parameters:
dataInfo Information on the type of data required.
data The raw data is returned in this object.

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

This call adds an event server to call on events such as the "dataEvent" generated by the requestData(0 call as well as error events. The Client will use this to notify the TmsServer of its local TmsEvent object.

Parameters:
name The BOAP object name to add.
Adds an event server that gets called on certain TmsServer events such as CYCLE_START, CYCLE_STOP and errors.

BError Tms::TmsProcess::requestData ( 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.

Parameters:
dataInfo Information on the type of data required.


The documentation for this class was generated from the following files:
Generated on Thu Aug 2 16:16:46 2007 for LibTmsApi by  doxygen 1.5.1