SetAxisVelocity

Sets the target velocity of an axis. This function can be used only in the Direct Velocity control mode, in which this is the only function to set the target velocity of an axis.

Syntax

KsError SetAxisVelocity(
     int Index,
     double Velocity
);

Parameters

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

Velocity: the velocity of an axis in user unit per second.

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

Using the Direct Velocity mode you can set an axis' velocity every cycle based on your needs or customized interpolation.

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksmotion.h ksmotion.h
Library KsApi_Rtss.lib KsApi.lib

See also

GetAxisVelocity

SetAxisPosition

SetAxisTorque