mpiCompensatorCreate

Declaration

MPI_RESULT
   mpiCompensatorCreate(MPICompensator  *compensator,
                        MPIControl      control,
                        int32_t            number);

Required Header: stdmpi.h

Change History: Modified in 04.00.

Description

mpiCompensatorCreate creates a Host Compensator object associated with the compensation object identified by number located on motion controller control. CompensatorCreate is the equivalent of a C++ constructor.

Valid compensator numbers are zero (0) to MPIControlMAX_COMPENSATORS.

Before creating a Compensator object, the controller compensation objects must be enabled using MPIControlConfig.compensatorCount, or the host object will be invalid.

compensator	A pointer to uninitialized compensator object which is instansiated by this method.
control	A handle to the controller object.
number	Index of the compensator object. Valid numbers are between zero to MPIControlMAXCOMPENSATORS.

Return Values

MPIMessageOK

MPIMessageARG_INVALID

MPICompensatorMessageCOMPENSATOR_INVALID