MPICompensatorMessage

Definition

typedef enum {
   MPICompensatorMessageCOMPENSATOR_INVALID,
   MPICompensatorMessageNOT_CONFIGURED,
   MPICompensatorMessageNOT_ENABLED,
   MPICompensatorMessageAXIS_NOT_ENABLED,
   MPICompensatorMessageTABLE_SIZE_ERROR,
   MPICompensatorMessagePOSITION_DELTA_INVALID,
   MPICompensatorMessageDIMENSION_NOT_SUPPORTED,
} MPICompensatorMessage;

Description

MPICompensatorMessageCOMPENSATOR_INVALID
	The compensator number is not valid. This message code is returned by mpiCompensatorCreate(...) if the compensator number is less than 0 or greater than MPIControlMAX_COMPENSATORS.
MPICompensatorMessageNOT_CONFIGURED
	MPI Compensator object must be configured before calling mpiCompensatorTableGet/ Set or mpiCompensatorInfo(...).
MPICompensatorMessageNOT_ENABLED
	The compensator is not available on the controller. This message code is returned by mpiCompensatorValidate(…) if the compensator number is not within the range of enabled compensators on the controller. To correct the problem, use MPIControlConfig to configure the compensatorCount to be greater than the required compensator number.
MPICompensatorMessageAXIS_NOT_ENABLED
	The axis is not available on the controller. This message coder is returned by mpiCompensatorConfigSet(...) if the axisOutNumber or any of the inputAxis[n].axisNumbers are not within the range of enabled axes on the controller. To correct the problem, use MPIControlConfig to configure the axisCount to be greater than the required axis number.
MPICompensatorMessageTABLE_SIZE_ERROR
	The host compenstation table will not fit within the controller's configured compensation table. See Determining Required Compensation Table Size.
MPICompensatorMessagePOSITION_DELTA_INVALID
	The positionDelta is either out of range or is not a multiple of the range. This message code is returned by mpiCompensatorConfigSet(…). To correct the problem, check the valid range values for MPICompensatorInputAxis.
MPICompensatorMessageDIMENSION_NOT_SUPPORTED
	The dimensionCount is out of range. This message code is returned by mpiCompensatorConfigSet(…). To correct the problem, check the valid range values for MPICompensatorConfig.