mpiAxisMotorMapGet

Declaration

	long mpiAxisMotorMapGet(MPIAxis axis, MPIObjectMap *motorMap)
	Required Header: stdmpi.h

Description

mpiAxisMotorMapGet gets the object map [of the Motors associated with an Axis (axis)] and writes it into the structure pointed to by motorMap.

axis	a handle to the Axis object.
*motorMap	a pointer to an ObjectMap of Motors mapped to the axis

Remarks

MPIObjectMap is a long that maps the Motors in controller memory to each bit. Ex: A map value of 1 would indicate Motor 0 is mapped the Axis. A value of 6 would indicate that Motors 2 and 3 are mapped to the Axis.

Remember that Motors are mapped to Axes through the Filter object. To configure the Axis/Motor map, the application will need to set the mpiAxisFilterMap and mpiFilterMotorMap.

Return Values
MPIMessageOK