Class ApiBufferStatus

Class Documentation

class ApiBufferStatus

This class contains the current status of an API buffer channnel. Also see API Buffer Statuses.

Public Functions

ApiBufferStatus()

Public Members

ApiBufferState::T state

The current state of the API buffer channel.

int blockCount

The total number of blocks in the API buffer.

int remainingBlockCount

The number of blocks that remain to be executed in the API buffer.

int bufferSize

The size of the API buffer in bytes. The buffer size is specified when the API buffer is created using the CreateApiBuffer function.

int freeSize

The size of the free space in the API buffer in bytes. An API function may fail to be added to the API buffer if there is not enough space remaining in the buffer. Once an API function has been executed from the buffer, the space it occupied will be freed and this status will increase by the freed amount.

int execBlockCount

The number of blocks that have been executed from the API buffer.

int errorCount

The number of errors that have been encountered. The first errorCount indices of the errorLog array will contain the errors that have been returned by API functions called through the API buffer.

ApiBufferErrorLog errorLog[constants::maxApiBufferErrorLog]

An array of ApiBufferErrorLog objects that contain the log of errors that have been returned by API functions called through the API buffer. If the number of encountered errors exceeds maxApiBufferErrorLog, errors will be deleted in order of oldest to newest.

bool watchError

This value is TRUE if a watch error has occurred. This value is always FALSE if the watch function is disabled. This value is cleared to FALSE when the SetWatch function updates the watch options.

int watchErrorCode

This value is set to ServoOffline, AxisAmpAlarm, ServoOff, AxisHardLimit, AxisNearLimit, AxisExternalLimit, or AxisSoftLimit depending on the cause of the watch error. This value has no meaning if the watchError status is FALSE.

int watchErrorAxis

This value is set to the axis number of the axis that caused the watch error. This value has no meaning if the watchError status is FALSE.