Class TriggerEvent

Nested Relationships

Nested Types

Class Documentation

class TriggerEvent

This class describes an event used in trigger motion.

Public Functions

TriggerEvent()

Public Members

TriggerEventInputFunction::T inputFunction

The input function (condition) of the trigger event. The struct of the “input” union that is used depends on the selection of the input function.

union wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments input

Arguments for the input function of the trigger event.

TriggerEventOutputFunction::T outputFunction

The output function (action) of the trigger event. The struct of the “output” union that is used depends on the selection of the output function.

union wmx3Api::TriggerEvent::TriggerEventOutputFunctionArguments output

Arguments for the output function of the trigger event.

union TriggerEventInputFunctionArguments

This union defines the structs containing arguments for each input function type.

Public Functions

TriggerEventInputFunctionArguments()

Public Members

struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::IOBit ioBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NotIOBit notIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::OrIOBit orIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::AndIOBit andIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::XorIOBit xorIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NandIOBit nandIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NorIOBit norIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::XnorIOBit xnorIOBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::MBit mBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NotMBit notMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::OrMBit orMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::AndMBit andMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::XorMBit xorMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NandMBit nandMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NorMBit norMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::XnorMBit xnorMBit
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::Reg reg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NotReg notReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::OrReg orReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::AndReg andReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::XorReg xorReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NandReg nandReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::NorReg norReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::XnorReg xnorReg
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::EqualPos equalPos
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::GreaterPos greaterPos
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::LessPos lessPos
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::EqualVelocity equalVelocity
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::GreaterVelocity greaterVelocity
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::LessVelocity lessVelocity
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::EqualTrq equalTrq
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::GreaterTrq greaterTrq
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::LessTrq lessTrq
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::RemainingTime remainingTime
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::RemainingDistance remainingDistance
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::SameTimeCompletion sameTimeCompletion
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::CompletedTime completedTime
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::CompletedDistance completedDistance
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::StaggeredTimeCompletion staggeredTimeCompletion
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::StaggeredDistanceCompletion staggeredDistanceCompletion
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::DistanceToTarget distanceToTarget
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::AxisIdle axisIdle
struct wmx3Api::TriggerEvent::TriggerEventInputFunctionArguments::GreaterPositionError greaterPositionError
struct AndIOBit

This structure contains arguments for the AndIOBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first I/O bit is specified in byteAddress[0]. The byte address of the second I/O bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first I/O bit is specified in bitAddress[0]. The bit address of the second I/O bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first I/O bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first I/O bit is processed normally. If invert[1] is set to 1, the value of the second I/O bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second I/O bit is processed normally.

IOSourceType::T ioSourceType[2]

Determines the source of the I/O (input or output). ioSourceType[0] corresponds to the first I/O bit and ioSourceType[1] corresponds to the second I/O bit.

struct AndMBit

This structure contains arguments for the AndMBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first user memory bit is specified in byteAddress[0]. The byte address of the second user memory bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first user memory bit is specified in bitAddress[0]. The bit address of the second user memory bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first user memory bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first user memory bit is processed normally. If invert[1] is set to 1, the value of the second user memory bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second user memory bit is processed normally.

struct AndReg

This structure contains arguments for the AndReg input function type.

Public Members

unsigned int regNumber[2]

The number of the first register is specified in regNumber[0]. The number of the second register is specified in regNumber[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first register will be inverted when evaluating the condition. If invert[0] is set to 0, the first register is processed normally. If invert[1] is set to 1, the value of the second register will be inverted when evaluating the condition. If invert[1] is set to 0, the second register is processed normally.

struct AxisIdle

This structure contains arguments for the AxisIdle input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis is not in the Idle operation state. If set to 0, the input function is processed normally.

struct CompletedDistance

This structure contains arguments for the CompletedDistance input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the completed distance for the position command is less than the specified value. The condition will be FALSE if the axis is not executing a position command. If set to 0, the input function is processed normally.

double distance

The distance at which the condition becomes TRUE, in user units.

struct CompletedTime

This structure contains arguments for the CompletedTime input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the elapsed time for the position command is less than the specified value. The condition will be FALSE if the axis is not executing a position command. If set to 0, the input function is processed normally.

double timeMilliseconds

The time at which the condition becomes TRUE, in units of milliseconds.

struct DistanceToTarget

This structure contains arguments for the DistanceToTarget input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the distance from the current position to the target position of the motion is greater than the specified value. The condition will be FALSE if the axis is not executing a position command. If set to 0, the input function is processed normally.

double distance

The distance at which the condition becomes TRUE, in user units.

struct EqualPos

This structure contains arguments for the EqualPos input function type.

Public Members

unsigned int axis

The axis to monitor.

double pos

The position at which the condition becomes TRUE.

unsigned char disablePositiveDirection

If 0, process the input function normally. If 1, the condition will not become TRUE while the axis is stationary or traveling in the positive direction.

unsigned char disableNegativeDirection

If 0, process the input function normally. If 1, the condition will not become TRUE while the axis is stationary or traveling in the negative direction.

unsigned char useFeedback

If 0, the command position will be monitored. If 1, the feedback position will be monitored.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis is not at the specified position and is not passing the specified position. If set to 0, the input function is processed normally.

unsigned char enableTolerance

If set to 1, the tolerance parameter determines the difference between the specified position and the position of the axis below which the condition will evaluate to TRUE. If set to 0, the tolerance will be set to the default value of 0.5 user units.

double tolerance

If the enableTolerance parameter is set to 1, this parameter determines the difference between the specified position and the position of the axis below which the condition will evaluate to TRUE. This parameter is specified in units of user units.

struct EqualTrq

This structure contains arguments for the EqualTrq input function type.

Public Members

unsigned int axis

The axis to monitor.

double trq

The torque at which the condition becomes TRUE.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis is not at the specified torque. If set to 0, the input function is processed normally.

unsigned char enableTolerance

If set to 1, the tolerance parameter determines the difference between the specified torque and the torque of the axis below which the condition will evaluate to TRUE. If set to 0, the tolerance will be set to the default value of 0.5 (in 0.1% units, indicating a tolerance of 0.05%).

double tolerance

If the enableTolerance parameter is set to 1, this parameter determines the difference between the specified torque and the torque of the axis below which the condition will evaluate to TRUE. This parameter is specified in 0.1% units.

unsigned char enableUnsigned

If set to 1, the trq parameter is specified as an unsigned value. The input function is evaluated using the absolute value of the axis torque. If set to 0, the trq parameter is specified as a signed value. The input function is evaluated using a negative torque when the torque is applied in the negative direction.

struct EqualVelocity

This structure contains arguments for the EqualVelocity input function type.

Public Members

unsigned int axis

The axis to monitor.

double velocity

The velocity at which the condition becomes TRUE.

unsigned char useFeedback

If 0, the command velocity will be monitored. If 1, the feedback velocity will be monitored.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis is not at the specified velocity. If set to 0, the input function is processed normally.

unsigned char enableTolerance

If set to 1, the tolerance parameter determines the difference between the specified velocity and the velocity of the axis below which the condition will evaluate to TRUE. If set to 0, the tolerance will be set to the default value of 0.5 user units per second.

double tolerance

If the enableTolerance parameter is set to 1, this parameter determines the difference between the specified velocity and the velocity of the axis below which the condition will evaluate to TRUE. This parameter is specified in units of user units per second.

unsigned char enableUnsigned

If set to 1, the velocity parameter is specified as an unsigned value. The input function is evaluated using the absolute value of the axis velocity. If set to 0, the velocity parameter is specified as a signed value. The input function is evaluated using a negative velocity when traveling in the negative direction.

struct GreaterPos

This structure contains arguments for the GreaterPos input function type.

Public Members

unsigned int axis

The axis to monitor.

double pos

The position at which the condition becomes TRUE.

unsigned char disablePositiveDirection

If 0, process the input function normally. If 1, the condition will not become TRUE while the axis is stationary or traveling in the positive direction.

unsigned char disableNegativeDirection

If 0, process the input function normally. If 1, the condition will not become TRUE while the axis is stationary or traveling in the negative direction.

unsigned char useFeedback

If 0, the command position will be monitored. If 1, the feedback position will be monitored.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis position is not greater than the specified position. If set to 0, the input function is processed normally.

struct GreaterPositionError

This structure contains arguments for the GreaterPositionError input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the position error is same or lesser than the specified value. If set to 0, the input function is processed normally.

double posError

The position error at which the condition becomes TRUE. If useActualFollowingError is 0, it is specified in user units; if 1, it is specified in pulse units.

unsigned char useActualFollowingError

If set to 0, the difference between the command position (Pos Cmd) and feedback position (Actual Pos) is monitored. If set to 1, feedback following error (Actual Following Error) sent from the servo is monitored.

struct GreaterTrq

This structure contains arguments for the GreaterTrq input function type.

Public Members

unsigned int axis

The axis to monitor.

double trq

The torque at which the condition becomes TRUE.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis torque is not greater than the specified torque. If set to 0, the input function is processed normally.

unsigned char enableUnsigned

If set to 1, the trq parameter is specified as an unsigned value. The input function is evaluated using the absolute value of the axis torque. If set to 0, the trq parameter is specified as a signed value. The input function is evaluated using a negative torque when the torque is applied in the negative direction.

struct GreaterVelocity

This structure contains arguments for the GreaterVelocity input function type.

Public Members

unsigned int axis

The axis to monitor.

double velocity

The velocity at which the condition becomes TRUE.

unsigned char useFeedback

If 0, the command velocity will be monitored. If 1, the feedback velocity will be monitored.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis velocity is not greater than the specified velocity. If set to 0, the input function is processed normally.

unsigned char enableUnsigned

If set to 1, the velocity parameter is specified as an unsigned value. The input function is evaluated using the absolute value of the axis velocity. If set to 0, the velocity parameter is specified as a signed value. The input function is evaluated using a negative velocity when traveling in the negative direction.

struct IOBit

This structure contains arguments for the IOBit input function type.

Public Members

unsigned int byteAddress

The byte address of the I/O bit.

unsigned char bitAddress

The bit address of the I/O bit.

unsigned char invert

If set to 1, the value of the I/O bit will be inverted when evaluating the condition. In this case, the condition will be TRUE when the I/O bit is 0. If set to 0, the I/O bit is processed normally.

IOSourceType::T ioSourceType

The source of the I/O (input or output).

struct LessPos

This structure contains arguments for the LessPos input function type.

Public Members

unsigned int axis

The axis to monitor.

double pos

The position at which the condition becomes TRUE.

unsigned char disablePositiveDirection

If 0, process the input function normally. If 1, the condition will not become TRUE while the axis is stationary or traveling in the positive direction.

unsigned char disableNegativeDirection

If 0, process the input function normally. If 1, the condition will not become TRUE while the axis is stationary or traveling in the negative direction.

unsigned char useFeedback

If 0, the command position will be monitored. If 1, the feedback position will be monitored.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis position is not less than the specified position. If set to 0, the input function is processed normally.

struct LessTrq

This structure contains arguments for the LessTrq input function type.

Public Members

unsigned int axis

The axis to monitor.

double trq

The torque at which the condition becomes TRUE.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis torque is not less than the specified torque. If set to 0, the input function is processed normally.

unsigned char enableUnsigned

If set to 1, the trq parameter is specified as an unsigned value. The input function is evaluated using the absolute value of the axis torque. If set to 0, the trq parameter is specified as a signed value. The input function is evaluated using a negative torque when the torque is applied in the negative direction.

struct LessVelocity

This structure contains arguments for the LessVelocity input function type.

Public Members

unsigned int axis

The axis to monitor.

double velocity

The velocity at which the condition becomes TRUE.

unsigned char useFeedback

If 0, the command velocity will be monitored. If 1, the feedback velocity will be monitored.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the axis velocity is not less than the specified velocity. If set to 0, the input function is processed normally.

unsigned char enableUnsigned

If set to 1, the velocity parameter is specified as an unsigned value. The input function is evaluated using the absolute value of the axis velocity. If set to 0, the velocity parameter is specified as a signed value. The input function is evaluated using a negative velocity when traveling in the negative direction.

struct MBit

This structure contains arguments for the MBit input function 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 set to 1, the value of the user memory bit will be inverted when evaluating the condition. In this case, the condition will be TRUE when the user memory bit is 0. If set to 0, the user memory bit is processed normally.

struct NandIOBit

This structure contains arguments for the NandIOBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first I/O bit is specified in byteAddress[0]. The byte address of the second I/O bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first I/O bit is specified in bitAddress[0]. The bit address of the second I/O bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first I/O bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first I/O bit is processed normally. If invert[1] is set to 1, the value of the second I/O bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second I/O bit is processed normally.

IOSourceType::T ioSourceType[2]

Determines the source of the I/O (input or output). ioSourceType[0] corresponds to the first I/O bit and ioSourceType[1] corresponds to the second I/O bit.

struct NandMBit

This structure contains arguments for the NandMBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first user memory bit is specified in byteAddress[0]. The byte address of the second user memory bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first user memory bit is specified in bitAddress[0]. The bit address of the second user memory bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first user memory bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first user memory bit is processed normally. If invert[1] is set to 1, the value of the second user memory bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second user memory bit is processed normally.

struct NandReg

This structure contains arguments for the NandReg input function type.

Public Members

unsigned int regNumber[2]

The number of the first register is specified in regNumber[0]. The number of the second register is specified in regNumber[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first register will be inverted when evaluating the condition. If invert[0] is set to 0, the first register is processed normally. If invert[1] is set to 1, the value of the second register will be inverted when evaluating the condition. If invert[1] is set to 0, the second register is processed normally.

struct NorIOBit

This structure contains arguments for the NorIOBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first I/O bit is specified in byteAddress[0]. The byte address of the second I/O bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first I/O bit is specified in bitAddress[0]. The bit address of the second I/O bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first I/O bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first I/O bit is processed normally. If invert[1] is set to 1, the value of the second I/O bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second I/O bit is processed normally.

IOSourceType::T ioSourceType[2]

Determines the source of the I/O (input or output). ioSourceType[0] corresponds to the first I/O bit and ioSourceType[1] corresponds to the second I/O bit.

struct NorMBit

This structure contains arguments for the NorMBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first user memory bit is specified in byteAddress[0]. The byte address of the second user memory bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first user memory bit is specified in bitAddress[0]. The bit address of the second user memory bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first user memory bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first user memory bit is processed normally. If invert[1] is set to 1, the value of the second user memory bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second user memory bit is processed normally.

struct NorReg

This structure contains arguments for the NorReg input function type.

Public Members

unsigned int regNumber[2]

The number of the first register is specified in regNumber[0]. The number of the second register is specified in regNumber[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first register will be inverted when evaluating the condition. If invert[0] is set to 0, the first register is processed normally. If invert[1] is set to 1, the value of the second register will be inverted when evaluating the condition. If invert[1] is set to 0, the second register is processed normally.

struct NotIOBit

This structure contains arguments for the NotIOBit input function type.

Public Members

unsigned int byteAddress

The byte address of the I/O bit.

unsigned char bitAddress

The bit address of the I/O bit.

unsigned char invert

If set to 1, the value of the I/O bit will be inverted when evaluating the condition. In this case, the condition will be TRUE when the I/O bit is 1. If set to 0, the I/O bit is processed normally.

IOSourceType::T ioSourceType

The source of the I/O (input or output).

struct NotMBit

This structure contains arguments for the NotMBit input function 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 set to 1, the value of the user memory bit will be inverted when evaluating the condition. In this case, the condition will be TRUE when the user memory bit is 1. If set to 0, the user memory bit is processed normally.

struct NotReg

This structure contains arguments for the NotReg input function type.

Public Members

unsigned int regNumber

The number of the register. This must be between 0 and 7.

unsigned char invert

If set to 1, the value of the register will be inverted when evaluating the condition. In this case, the condition will be TRUE when the register is 1. If set to 0, the register is processed normally.

struct OrIOBit

This structure contains arguments for the OrIOBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first I/O bit is specified in byteAddress[0]. The byte address of the second I/O bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first I/O bit is specified in bitAddress[0]. The bit address of the second I/O bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first I/O bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first I/O bit is processed normally. If invert[1] is set to 1, the value of the second I/O bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second I/O bit is processed normally.

IOSourceType::T ioSourceType[2]

The source of the I/O (input or output). ioSourceType[0] corresponds to the first I/O bit and ioSourceType[1] corresponds to the second I/O bit.

struct OrMBit

This structure contains arguments for the OrMBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first user memory bit is specified in byteAddress[0]. The byte address of the second user memory bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first user memory bit is specified in bitAddress[0]. The bit address of the second user memory bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first user memory bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first user memory bit is processed normally. If invert[1] is set to 1, the value of the second user memory bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second user memory bit is processed normally.

struct OrReg

This structure contains arguments for the OrReg input function type.

Public Members

unsigned int regNumber[2]

The number of the first register is specified in regNumber[0]. The number of the second register is specified in regNumber[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first register will be inverted when evaluating the condition. If invert[0] is set to 0, the first register is processed normally. If invert[1] is set to 1, the value of the second register will be inverted when evaluating the condition. If invert[1] is set to 0, the second register is processed normally.

struct Reg

This structure contains arguments for the Reg input function type.

Public Members

unsigned int regNumber

The number of the register. This must be between 0 and 7.

unsigned char invert

If set to 1, the value of the register will be inverted when evaluating the condition. In this case, the condition will be TRUE when the register is 0. If set to 0, the register is processed normally.

struct RemainingDistance

This structure contains arguments for the RemainingDistance input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the remaining distance for the position command is greater than the specified value. The condition will be FALSE if the axis is not executing a position command. If set to 0, the input function is processed normally.

double distance

The distance at which the condition becomes TRUE, in user units.

struct RemainingTime

This structure contains arguments for the RemainingTime input function type.

Public Members

unsigned int axis

The axis to monitor.

unsigned char invert

If set to 1, the result of the input function is inverted. The condition will be TRUE when the remaining time for the position command is greater than the specified value. The condition will be FALSE if the axis is not executing a position command. If set to 0, the input function is processed normally.

double timeMilliseconds

The time at which the condition becomes TRUE, in units of milliseconds.

struct SameTimeCompletion

This structure contains arguments for the SameTimeCompletion input function type.

Public Members

unsigned int axis

The axis to monitor.

struct StaggeredDistanceCompletion

This structure contains arguments for the StaggeredDistanceCompletion input function type.

Public Members

unsigned int axis

The axis to monitor.

double distance

The distance at which the condition becomes TRUE, in user units.

struct StaggeredTimeCompletion

This structure contains arguments for the StaggeredTimeCompletion input function type.

Public Members

unsigned int axis

The axis to monitor.

double timeMilliseconds

The time at which the condition becomes TRUE, in units of milliseconds.

struct XnorIOBit

This structure contains arguments for the XnorIOBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first I/O bit is specified in byteAddress[0]. The byte address of the second I/O bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first I/O bit is specified in bitAddress[0]. The bit address of the second I/O bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first I/O bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first I/O bit is processed normally. If invert[1] is set to 1, the value of the second I/O bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second I/O bit is processed normally.

IOSourceType::T ioSourceType[2]

Determines the source of the I/O (input or output). ioSourceType[0] corresponds to the first I/O bit and ioSourceType[1] corresponds to the second I/O bit.

struct XnorMBit

This structure contains arguments for the XnorMBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first user memory bit is specified in byteAddress[0]. The byte address of the second user memory bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first user memory bit is specified in bitAddress[0]. The bit address of the second user memory bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first user memory bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first user memory bit is processed normally. If invert[1] is set to 1, the value of the second user memory bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second user memory bit is processed normally.

struct XnorReg

This structure contains arguments for the XnorReg input function type.

Public Members

unsigned int regNumber[2]

The number of the first register is specified in regNumber[0]. The number of the second register is specified in regNumber[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first register will be inverted when evaluating the condition. If invert[0] is set to 0, the first register is processed normally. If invert[1] is set to 1, the value of the second register will be inverted when evaluating the condition. If invert[1] is set to 0, the second register is processed normally.

struct XorIOBit

This structure contains arguments for the XorIOBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first I/O bit is specified in byteAddress[0]. The byte address of the second I/O bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first I/O bit is specified in bitAddress[0]. The bit address of the second I/O bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first I/O bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first I/O bit is processed normally. If invert[1] is set to 1, the value of the second I/O bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second I/O bit is processed normally.

IOSourceType::T ioSourceType[2]

Determines the source of the I/O (input or output). ioSourceType[0] corresponds to the first I/O bit and ioSourceType[1] corresponds to the second I/O bit.

struct XorMBit

This structure contains arguments for the XorMBit input function type.

Public Members

unsigned int byteAddress[2]

The byte address of the first user memory bit is specified in byteAddress[0]. The byte address of the second user memory bit is specified in byteAddress[1].

unsigned char bitAddress[2]

The bit address of the first user memory bit is specified in bitAddress[0]. The bit address of the second user memory bit is specified in bitAddress[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first user memory bit will be inverted when evaluating the condition. If invert[0] is set to 0, the first user memory bit is processed normally. If invert[1] is set to 1, the value of the second user memory bit will be inverted when evaluating the condition. If invert[1] is set to 0, the second user memory bit is processed normally.

struct XorReg

This structure contains arguments for the XorReg input function type.

Public Members

unsigned int regNumber[2]

The number of the first register is specified in regNumber[0]. The number of the second register is specified in regNumber[1].

unsigned char invert[2]

If invert[0] is set to 1, the value of the first register will be inverted when evaluating the condition. If invert[0] is set to 0, the first register is processed normally. If invert[1] is set to 1, the value of the second register will be inverted when evaluating the condition. If invert[1] is set to 0, the second register is processed normally.

union TriggerEventOutputFunctionArguments

This union defines the structs containing arguments for each output function type.

Public Functions

TriggerEventOutputFunctionArguments()

Public Members

struct wmx3Api::TriggerEvent::TriggerEventOutputFunctionArguments::TriggerMotion triggerMotion
struct wmx3Api::TriggerEvent::TriggerEventOutputFunctionArguments::SetReg setReg
struct SetReg

This structure contains arguments for the SetReg output function type.

Public Members

unsigned int regNumber

The number of the register. This must be between 0 and 7.

struct TriggerMotion

This structure contains arguments for the TriggerMotion output function type.

Public Members

unsigned int reserved

Reserved.