Class ApiBufferCondition

Nested Relationships

Nested Types

Class Documentation

class ApiBufferCondition

This class contains a condition that is used to control the execution of an API buffer channel.

Public Functions

ApiBufferCondition()

Public Members

ApiBufferConditionType::T bufferConditionType

The API buffer condition type. This determines the type of condition.

union wmx3Api::ApiBufferCondition::ApiBufferConditionArguments arg

Arguments for the API buffer condition.

union ApiBufferConditionArguments

This union defines the structs containing arguments for each API buffer condition type.

Public Functions

ApiBufferConditionArguments()

Public Members

struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::NeverTrue neverTrue
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::AlwaysTrue alwaysTrue
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::IOInput ioInput
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::IOOutput ioOutput
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::UserMemory userMemory
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::MinimumTrq minimumTrq
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::OpState opState
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::AxisCmdMode axisCmdMode
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::InPos inPos
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::PosSET posSET
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::DelayedPosSET delayedPosSET
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::CommandDistributedEnd commandDistributedEnd
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::RemainingTime remainingTime
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::RemainingDistance remainingDistance
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::CompletedTime completedTime
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::CompletedDistance completedDistance
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::DistanceToTarget distanceToTarget
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::DecelerationStarted decelerationStarted
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::AxisIdle axisIdle
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::MotionStarted motionStarted
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::MotionStartedOverrideReady motionStartedOverrideReady
struct wmx3Api::ApiBufferCondition::ApiBufferConditionArguments::Event event
struct AlwaysTrue

This structure contains arguments for the AlwaysTrue API buffer condition type.

Public Members

int reserved

Reserved.

struct AxisCmdMode

This structure contains arguments for the AxisCmdMode API buffer condition type.

Public Members

int axis

The axis to monitor.

AxisCommandMode::T axisCommandMode

The AxisCommandMode for which the condition evaluates to TRUE.

unsigned char useFeedback

If 0, the value of the Axis Command Mode status will be monitored. If 1, the value of the Axis Command Mode Feedback status will be monitored.

struct AxisIdle

This structure contains arguments for the AxisIdle API buffer condition type.

Public Members

unsigned int axisCount

The number of axes to monitor. The first axisCount indices in the axis array should contain the axis numbers of the axes to monitor.

int axis[constants::maxAxes]

An array containing the axis numbers of the axes to monitor. The first axisCount indices should contain the axis numbers.

struct CommandDistributedEnd

This structure contains arguments for the CommandDistributedEnd API buffer condition type.

Public Members

int axis

The axis to monitor.

struct CompletedDistance

This structure contains arguments for the CompletedDistance API buffer condition type.

Public Members

int axis

The axis to monitor.

double distance

The completed distance above which the condition evaluates to TRUE, in user units.

struct CompletedTime

This structure contains arguments for the CompletedTime API buffer condition type.

Public Members

int axis

The axis to monitor.

double timeMilliseconds

The elapsed time above which the condition evaluates to TRUE, in units of milliseconds.

struct DecelerationStarted

This structure contains arguments for the DecelerationStarted API buffer condition type.

Public Members

int axis

The axis to monitor.

struct DelayedPosSET

This structure contains arguments for the DelayedPosSET API buffer condition type.

Public Members

int axis

The axis to monitor.

struct DistanceToTarget

This structure contains arguments for the DistanceToTarget API buffer condition type.

Public Members

int axis

The axis to monitor.

double distance

The distance to the target position below which the condition evaluates to TRUE, in user units.

struct Event

This structure contains arguments for the Event API buffer condition type.

Public Members

unsigned int eventID

The ID of the event.

struct InPos

This structure contains arguments for the InPos API buffer condition type.

Public Members

int axis

The axis to monitor.

unsigned int channel

The in position status channel, between 0 and maxInPosChannel-1. 0 corresponds to In Pos, 1 corresponds to In Pos 2, and so on.

struct IOInput

This structure contains arguments for the IOInput API buffer condition type.

Public Members

unsigned int byteAddress

The byte address of the I/O input bit.

unsigned char bitAddress

The bit address of the I/O input bit.

unsigned char invert

If this value is 0, the condition evaluates to TRUE when the I/O input bit is 1. If this value is 1, the condition evaluates to TRUE when the I/O input bit is 0.

struct IOOutput

This structure contains arguments for the IOOutput API buffer condition type.

Public Members

unsigned int byteAddress

The byte address of the I/O output bit.

unsigned char bitAddress

The bit address of the I/O output bit.

unsigned char invert

If this value is 0, the condition evaluates to TRUE when the I/O output bit is 1. If this value is 1, the condition evaluates to TRUE when the I/O output bit is 0.

struct MinimumTrq

This structure contains arguments for the MinimumTrq API buffer condition type.

Public Members

int axis

The axis to monitor.

double torque

The minimum torque feedback for the condition to evaluate to TRUE, in units of [%].

struct MotionStarted

This structure contains arguments for the MotionStarted API buffer condition type.

Public Members

int axis

The axis to monitor.

struct MotionStartedOverrideReady

This structure contains arguments for the MotionStartedOverrideReady API buffer condition type.

Public Members

int axis

The axis to monitor.

struct NeverTrue

This structure contains arguments for the NeverTrue API buffer condition type.

Public Members

int reserved

Reserved.

struct OpState

This structure contains arguments for the OpState API buffer condition type.

Public Members

int axis

The axis to monitor.

OperationState::T opState

The OperationState for which the condition evaluates to TRUE.

struct PosSET

This structure contains arguments for the PosSET API buffer condition type.

Public Members

int axis

The axis to monitor.

struct RemainingDistance

This structure contains arguments for the RemainingDistance API buffer condition type.

Public Members

int axis

The axis to monitor.

double distance

The remaining distance below which the condition evaluates to TRUE, in user units.

struct RemainingTime

This structure contains arguments for the RemainingTime API buffer condition type.

Public Members

int axis

The axis to monitor.

double timeMilliseconds

The remaining time below which the condition evaluates to TRUE, in units of milliseconds.

struct UserMemory

This structure contains arguments for the UserMemory API buffer condition type.

Public Members

unsigned int byteAddress

The byte address of the user memory bit.

unsigned char bitAddress

The bit address of the user memory bit.

unsigned char invert

If this value is 0, the condition evaluates to TRUE when the user memory bit is 1. If this value is 1, the condition evaluates to TRUE when the user memory bit is 0.