#include <TmsC.h>
Inheritance diagram for Tms::TmsProcess:
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. |
Tms::TmsProcess::TmsProcess | ( | BString | name = "" |
) |
name | The name of the TmsProcess BOAP object to connect to. |
Gets the software version.
version | A string variable filled in with the version number string. |
Gets the current cycle number and type.
cycleNumber | The current cycle number is returned here | |
cycleType | The current cycle type is returned here. |
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.
dataInfo | Information on the type of data required. | |
data | The raw data is returned in this object. |
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.
name | The BOAP object name to add. |
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.
dataInfo | Information on the type of data required. |