MPIAxisStatus

Definition

typedef struct MPIAxisStatus {
    MPIState        state;
    MPIAction       action;
    MPIEventMask    eventMask;
    MPI_BOOL        settled;
    MPI_BOOL        atTarget;
    MPIActionSource actionSource;
} MPIAxisStatus;

Required Header: axis.h
Change History: Added in 04.00.

Description

MPIAxisStatus is a structure that contains the present state, status, action, events, and cause of the action from the controller’s axis. The Axis status can be polled and displayed for informational purposes. If your application is using the status information to determine motion completion and trigger the next commanded move or handling controller events, it is STRONGLY recommended to use the Notify, Event, and EventMgr features.

Note: Using events for application logic decisions is more efficient than polling status.

state	Present condition of the controller’s axis.
action	Last or present action performed by the controller’s axis.
eventMask	A bit mask containing the events that are active or latched for the controller’s axis. This is useful for determining the fault conditions or axis motion progress.
settled	A Boolean value (TRUE or FALSE) indicating if all the axes mapped to the controller’s axis have met has met its configured settling criteria.
atTarget	A Boolean value (TRUE or FALSE) indicating if the axis has completed its commanded trajectories (command position has reached the targeted end point of the move).
actionSource	Indicates whether the state value was caused by the controller or the user.

MPIAxisStatus

Definition

Description

See Also