AxisGet()

Axis* AxisGet

(

int32_t

axisNumber

)

Description:

AxisGet takes an axis reference number and returns a pointer to the Axis object it represents.

Parameters

axisNumber

The reference number for the axis.

Returns

(Axis*) A pointer to the Axis specified.

Remarks

This function is also available in RapidSequencer. Part of the Create and Initialize RapidCode Objects method group.

Sample Code:

      Axis axis = controller.AxisGet(i);
      HelperFunctions.CheckErrors(axis);

Note

The RMP assigns a logical number to each axis as it encounters them during network initialization. The first axis is 0, the second 1, and so on. This logical sequential number is the axisNumber passed to AxisGet.

Getting the Axis will cause all of its internal default values and low-level objects to be recreated.

Examples

Gantry.cpp, HardwareLimits.cpp, Memory.cpp, MotionHoldReleasedBySoftwareAddress.cpp, MultiaxisMotion.cpp, PathMotion.cpp, PVTmotionMultiAxis.cpp, SingleAxisSyncOutputs.cpp, SyncInterrupt.cpp, SyncOutputWithMotion.cpp, Template.cpp, and UpdateBufferPoints.cpp.