mpiAxisCreate
Declaration
MPI_RESULT
mpiAxisCreate(MPIAxis *axis,
MPIControl control,
int32_t number);
Required Header: axis.h
Change History: Modified in 04.00.
Description
mpiAxisCreate creates an axis object associated with the axis identified by number located on motion controller control. AxisCreate is the equivalent of a C++ constructor.
| *axis | a pointer to an axis object. |
|---|---|
| control | a handle to a control object. |
| number | an index to the axis object in the controller. The valid range is 0 to MPIControlConfigDynamicMemAlloc.axisCount -1. |
| Return Values |
|---|
| MPIMessageOK |
| MPIAxisMessageAXIS_INVALID |
Remarks
An Axis represents a physical axis in space such as X, Y, Z, Theta, or other axes. An Axis may be comprised of one or more motors, such as with a gantry system.