Tms::TmsEvent Class Reference

This interface provides functions for events to be sent to clients from the TMS as a whole. More...

#include <TmsC.h>

Inheritance diagram for Tms::TmsEvent:

BoapClientObject BSocket BSocket List of all members.

Public Member Functions

 TmsEvent (BString name="")
BError errorEvent (UInt32 cycleNumber, BError error)
 This event function gets called on a system error. The errorEvent object contains and error number and string describing the error. The getStatus() call can be used to fetch further information.
BError cycleStartEvent (UInt32 cycleNumber)
 This event function gets called on the CYCLE_START event with the cycle number about to be processed.
BError cycleStopEvent (UInt32 cycleNumber)
 This event function gets called on the CYCLE_END event with the cycle number completed.
BError dataEvent (DataInfo dataInfo)
 This event function gets called when some requested data becomes available. The DataInfo object contains information on the data. The getData() call can be used to fetch the actual data.

Detailed Description

This interface provides functions for events to be sent to clients from the TMS as a whole.


Constructor & Destructor Documentation

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


Member Function Documentation

BError Tms::TmsEvent::errorEvent ( UInt32  cycleNumber,
BError  error 
)

This event function gets called on a system error. The errorEvent object contains and error number and string describing the error. The getStatus() call can be used to fetch further information.

BError Tms::TmsEvent::cycleStartEvent ( UInt32  cycleNumber  ) 

This event function gets called on the CYCLE_START event with the cycle number about to be processed.

BError Tms::TmsEvent::cycleStopEvent ( UInt32  cycleNumber  ) 

This event function gets called on the CYCLE_END event with the cycle number completed.

BError Tms::TmsEvent::dataEvent ( DataInfo  dataInfo  ) 

This event function gets called when some requested data becomes available. The DataInfo object contains information on the data. The getData() call can be used to fetch the actual data.


The documentation for this class was generated from the following files:
Generated on Tue Nov 27 09:20:06 2007 for LibTmsApi by  doxygen 1.5.1