GetAxisTorque

Gets the current torque from an axis. The torque can be set torque or actual torque.

Syntax

KsError GetAxisTorque(
     int Index,
     McSource Source,
     double* Torque
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Source: selects a torque value to read. See the McSource type.

Torque: pointer to the value to receive the torque.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

This function can be used only when the TorqueOffset feature is enabled.

Example

Copy

double axisTor = 0.0;
KsError nRet = GetAxisTorque(0, McSource::mcSetValue, &axisTor);

Requirements