Status Methods

Introduction | MPIStatus{...} Structure | MPIObjectStatus{...} Structure

Introduction

Status is read-only information that changes dynamically. Many objects define a Status structure and a method that uses that structure to return status to the application.

MPIStatus{...} Structure

The MPIStatus{...} structure contains information about the state of an axis or an entire motion. The Axis object and the Motion object return status using the MPIStatus{...} structure. Because the MPIStatus{...} structure is shared among objects, it is defined in the mpidef.h header file instead of being defined in an object header file.

For objects that involve more than 1 axis, the status returned by the motion object indicates the "sum" of the status conditions of the axes in its coordinate system. In general, the status structure gives an indication of whether an axis is moving or idle. The axis structure also indicates whether the axis is idle because of an error.

For MEI/XMP only

The filter object (whose handle is of type MPIFilter) also returns status in MPIStatus{...}.

MPIObjectStatus{...} Structure

Objects that are not Axis and Motion objects return status using an object-specific Status structure defined in the object's header file.

mpiObjectStatus(...)
For Axis and Motion objects, mpiObjectStatus(...) returns the object's status using the object's handle and a pointer to an MPIStatus{...} structure. For objects that are not Axis or Motion objects, mpiObjectStatus(...) returns the object's status using the object's handle and a pointer to an MPIObjectStatus{...} structure.