MotionController Axis MultiAxis IO IOPoint NetworkNode RsiError
Sample Apps Changelog

RapidCode API

◆ AxisGet()

RapidCode::Axis * AxisGet ( int32  axisNumber)
pure virtual

AxisGet returns a pointer to an Axis object and initializes its internals.

Description:
AxisGet takes an axis reference number and returns a pointer to the Axis object it represents.
Parameters
axisNumberThe reference number for the axis.
Returns
(Axis*) A pointer to the Axis specified.
Sample Code:
// -- C++ -- //
Axis *axisX = controller->AxisGet(X_AXIS_NUMBER);
// -- C# -- //
Axis axisX = controller.AxisGet(X_AXIS_NUMBER);
Note
SynqNet 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
AbsoluteMotion.cpp, AbsoluteMotion.cs, AxisSettling.cpp, AxisSettling.cs, AxisStatus.cpp, AxisStatus.cs, Camming.cpp, Camming.cs, Compensator1D.cs, Compensator2D.cs, CompensatorSingleAxis.cs, ConfigAmpFault.cpp, CustomEtherCATHome.cpp, CustomHome.cpp, DedicatedIO.cpp, DedicatedIO.cs, ErrorLog.cpp, ErrorLog.cs, FeedRate.cpp, FeedRate.cs, FinalVelocity.cpp, FinalVelocity.cs, Gantry.cpp, Gearing.cpp, Gearing.cs, HardwareLimits.cpp, HardwareLimits.cs, Home.cpp, HomeToNegativeLimit.cpp, HomeToNegativeLimit.cs, HomingWithAKDdrive.cpp, HomingWithAKDdrive.cs, HomingWithDS402drive.cs, IOwithAKD.cpp, Memory.cpp, MotionHoldReleasedByDigitalInput.cpp, MotionHoldReleasedByDigitalInput.cs, MotionHoldReleasedByPosition.cpp, MotionHoldReleasedByPosition.cs, MotionHoldReleasedBySoftwareAddress.cpp, MotionHoldReleasedBySoftwareAddress.cs, MultiaxisMotion.cpp, MultiAxisVelocityMotion.cs, PathMotion.cpp, PhantomAxis.cpp, PhantomAxis.cs, PointToPointMultiaxisMotion.cpp, PointToPointMultiaxisMotion.cs, PTmotion.cpp, PTmotion.cs, PTmotionWhileStopping.cpp, PTmotionWhileStopping.cs, PVAJTmotion.cs, PVTmotion.cpp, PVTmotion.cs, PVTmotionMultiAxis.cpp, Recorder.cpp, RelativeMotion.cpp, RelativeMotion.cs, SCurveMotion.cpp, SCurveMotion.cs, SettleCriteria.cpp, SetUserUnits.cpp, SetUserUnits.cs, SingleAxisSyncOutputs.cpp, SingleAxisSyncOutputs.cs, StopRate.cpp, StopRate.cs, SyncInterrupt.cpp, SyncOutputWithMotion.cpp, Template.cpp, TouchProbe.cs, UpdateBufferPoints.cpp, UserLimitCommandPositionDirectSet.cs, UserLimitDigitalInputEStopStorePosition.cs, UserLimitFeedRate.cs, UserLimitGainChangeBasedOnPosition.cpp, UserLimitPositionOneCondition.cpp, UserLimitPositionOneCondition.cs, UserLimitStateAction.cpp, VelocitySetByAnalogInputValue.cpp, and VelocitySetByAnalogInputValue.cs.