MPIAxisUserUnit

Declaration

      typedef struct MPIAxisUserUnit {
          double positionUnitScale;
          double velocityUnitScale;
          double accelerationUnitScale;
          double jerkUnitScale;
          char positionUnitLabel[MPIAxisUserUnitLabelMAX+1];
          char velocityUnitLabel[MPIAxisUserUnitLabelMAX+1];
          char accelerationUnitLabel[MPIAxisUserUnitLabelMAX+1];
          char jerkUnitLabel[MPIAxisUserUnitLabelMAX+1];
       } MPIAxisUserUnit;

Required Header: axis.h

Change History: Modified in 04.00.

Description

MPIAxisUserUnit is a structure containing the scale factors to convert the axis units from raw counts to Engineering units (examples: meters, feet, inches, etc.).  The MPIAxisUserUnit structure can be stored in the controller’s memory, so multiple application programs can take advantage of the scale factors.  Neither the controller, nor the MPI apply the scale factors to the axis, they are for application purposes only.

positionUnitScale .Magnitude to multiply position values reported in the desired user unit of position by to convert them to counts.  The value must be non-negative.
velocityUnitScale Magnitude to multiply position values reported in the desired user unit of position by to convert them to counts.  The value must be non-negative.
accelerationUnitScale Magnitude to multiply velocity values reported in the desired user unit of acceleration by to convert them to counts per second per second. The value must be non-negative.
jerkUnitScale Magnitude to multiply jerk values reported in the desired user unit of jerk by to convert them to counts per second per second per second. The value must be non-negative.
positionUnitLabel Name of the user unit of position.
velocityUnitLabel Name of the user unit of velocity.
accelerationUnitLabel Name of the user unit of acceleration.
jerkUnitLabel Name of the user unit of jerk.

See Also

mpiAxisConfigGet | mpiAxisConfigSet