MPI 04.00 Reference >> mpiMotion
mpiMotionAxisMapGet
Declaration
int32_t mpiMotionAxisMapGet(MPIMotion motion, MPIAxisMap *axisMap)
Required Header: stdmpi.h
Change History: Modified in 04.00.
Description
mpiMotionAxisMapGet writes the axis mapping data for the motion object to the contents of axisMap.
The motion supervisor to axis map is located in the controller's memory. The controller uses the axis map to coordinate moves, status, and actions between the axes. For example, if two axes (X and Y) are mapped to motion supervisor 0 and the X-axis faults with a position error limit, causing an ABORT action, the Y-axis will also execute an ABORT action. Another example is when moves are commanded, the motion supervisor will generate the motion DONE events with both the X-axis and Y-axis have met their settling criteria.
By default, the controller's motion supervisor to axis mapping is one to one. It is possible to configure two motion supervisors to share the same axis, but it is not possible to command moves on both motion supervisors simultaneously. When sharing axes, be aware you will need a motion supervisor that contains a map of all the shared axes, so error conditions can be cleared.
| motion | A handle to the Motion object. |
|---|---|
| axisMap | a pointer to an MPIMotionAxisMap |
| Return Values |
|---|
| MPIMessageOK |
| MPIMotionMessageMOTION_INVALID |