#include <TmsC.h>
Inheritance diagram for Tms::PuProcess:
Public Member Functions | |
PuProcess (BString name="") | |
BError | getVersion (BString &version) |
Gets the software version. | |
BError | setControlInfo (CycleParam params) |
Sets the control information for the cycle type given and subsequent cycles. 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 | 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 | 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. |
Tms::PuProcess::PuProcess | ( | BString | name = "" |
) |
BError Tms::PuProcess::setControlInfo | ( | CycleParam | params | ) |
Sets the control information for the cycle type given and subsequent cycles. 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.
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.
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.
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.