Peripheral Devices
9836 3521 01 561
8.14.4.22 GetCycleData
Description: Call this method to read the next Cycle data from the FIFO queue for the API device. The
data returned is interpreted as a string. Therefore this method should be used together with
a Reporter configured to format data Printable.
Note 1: The prompter text, or variable name, included for a variable by checking the "Text"
column in the Reporter is language dependent.
Note 2: The reporter executes on the TC and that it can only be configured using ToolsTalk
PowerMACS.
The FIFO queue can hold max 500 cycle data. If overflowed then the oldest data is
overwritten. Once a cycle data has been read by a call to this method it cannot be read
again. If the queue is empty when called then Buf is set to an empty string and eRetNoData
is returned. If Buf is to small to receive the read cycle data then Size is set to 0 and
eRetBufferToSmall is returned.
Return type: A RetCodeEnum value.
Syntax: object.GetCycleData(Buf, Size)
The Api object to operate on.
The string to receive the read cycle data.
At call: Max length of Buf, At return: The length of the returned
string in Buf.
8.14.4.23 GetCycleDataBin
Description: GetCycleDataBin performs the same function as GetCycleData with the difference that the
data returned is the raw binary data received from the TC. It is not interpreted in any way.
Therefore this method should be used together with a Reporter configured to format data
Binary. See chapter: GetCycleData for details.
Return type: A RetCodeEnum value.
Syntax: object.GetCycleDataBin(Buf, Size)
The Api object to operate on.
The byte array to receive the read cycle data.
At call: Max length of Buf, At return: The length of the
returned data in Buf.