Tms::TmsProcess Class Reference

This interface provides functions to configure and 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 setControlInfo (CycleParam params)
 Sets the control information for the cycle type given. The parameters for the processing cycle are passed, this includes the Phase and State table information. The call will return an error object indicating success or an error.
BError getControlInfo (BString cycleType, UInt32 puChannel, CycleParam &params)
 Gets the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error.
BError delControlInfo (BString cycleType, UInt32 puChannel)
 Deletes the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error.
BError getControlList (BList< CycleParamItem > &itemList)
 Gets the list of Cycle Parameters present in the system.
BError setNextCycle (UInt32 cycleNumber, BString cycleType)
 Sets the cycle number and type for the next processing cycle. The call will return an error object indicating success or an error condition as appropriate. This should be called at least 100ms before the next CYCLE_START event.
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 configure and capture data from the TMS as a whole.


Constructor & Destructor Documentation

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


Member Function Documentation

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

Gets the software version.

BError Tms::TmsProcess::setControlInfo ( CycleParam  params  ) 

Sets the control information for the cycle type given. The parameters for the processing cycle are passed, this includes the Phase and State table information. The call will return an error object indicating success or an error.

BError Tms::TmsProcess::getControlInfo ( BString  cycleType,
UInt32  puChannel,
CycleParam params 
)

Gets the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error.

BError Tms::TmsProcess::delControlInfo ( BString  cycleType,
UInt32  puChannel 
)

Deletes the control information for the cycle type and puChannel number given. The call will return an error object indicating success or an error.

BError Tms::TmsProcess::getControlList ( BList< CycleParamItem > &  itemList  ) 

Gets the list of Cycle Parameters present in the system.

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

Sets the cycle number and type for the next processing cycle. The call will return an error object indicating success or an error condition as appropriate. This should be called at least 100ms before the next CYCLE_START event.

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

Gets the current cycle number and type.

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.

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.

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.


The documentation for this class was generated from the following files:
Generated on Thu Jun 28 10:46:32 2007 for LibTmsApi by  doxygen 1.5.1