Class Profile¶

Defined in File WMX3Api.h

Class Documentation¶

class Profile¶

This class describes a motion profile.

Public Functions

Profile()¶

Public Members

ProfileType::T type¶

The profile type of the motion. The profile type determines the shape of the velocity curve.

The profile type of the motion. The profile type determines the shape of the velocity curve.

See also

Profile Parameters

double velocity¶

This parameter determines the target velocity of the profile.

This parameter determines the target velocity of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double acc¶

This parameter determines the acceleration of the profile.

This parameter determines the acceleration of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double dec¶

This parameter determines the deceleration of the profile.

This parameter determines the deceleration of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double jerkAcc¶

This parameter determines the acceleration jerk of the profile.

This parameter determines the acceleration jerk of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double jerkDec¶

This parameter determines the deceleration jerk of the profile.

This parameter determines the deceleration jerk of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double jerkAccRatio¶

This parameter determines the acceleration jerk ratio of the profile.

This parameter determines the acceleration jerk ratio of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double jerkDecRatio¶

This parameter determines the deceleration jerk ratio of the profile.

This parameter determines the deceleration jerk ratio of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double accTimeMilliseconds¶

This parameter determines the acceleration time of the profile.

This parameter determines the acceleration time of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double decTimeMilliseconds¶

This parameter determines the deceleration time of the profile.

This parameter determines the deceleration time of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double startingVelocity¶

This parameter determines the initial velocity of the profile.

This parameter determines the initial velocity of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double endVelocity¶

This parameter determines the end velocity of the profile.

This parameter determines the end velocity of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double secondVelocity¶

This parameter determines the second velocity of the profile.

This parameter determines the second velocity of the profile.

This parameter must be specified for the following profile types:

See also

Profile Parameters

double movingAverageTimeMilliseconds¶

This parameter determines the moving average time of the profile.

This parameter determines the moving average time of the profile.

This parameter must be specified for the following profile types:

TrapezoidalMAT

See also

Profile Parameters

Public Static Functions

static Profile __stdcall SetupTrapezoidal (double velocity, double acc, double dec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the Trapezoidal profile set as specified by the function arguments.

static Profile __stdcall SetupSCurve (double velocity, double acc, double dec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the SCurve profile set as specified by the function arguments.

static Profile __stdcall SetupJerkRatio (double velocity, double acc, double dec, double jerkAccRatio, double jerkDecRatio, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkRatio profile set as specified by the function arguments.

static Profile __stdcall SetupParabolic (double velocity, double acc, double dec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the Parabolic profile set as specified by the function arguments.

static Profile __stdcall SetupSin (double velocity, double acc, double dec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the Sin profile set as specified by the function arguments.

static Profile __stdcall SetupAdvancedS (double velocity, double acc, double dec, double jerkAccRatio, double jerkDecRatio, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the AdvancedS profile set as specified by the function arguments.

static Profile __stdcall SetupTrapezoidalMAT (double velocity, double acc, double dec, double movingAverageTimeMilliseconds, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TrapezoidalMAT profile set as specified by the function arguments.

static Profile __stdcall SetupJerkLimited (double velocity, double acc, double dec, double jerkAcc, double jerkDec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkLimited profile set as specified by the function arguments.

static Profile __stdcall SetupJerkLimitedSCurve (double velocity, double acc, double dec, double jerkAcc, double jerkDec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkLimitedSCurve profile set as specified by the function arguments.

static Profile __stdcall SetupJerkLimitedAdvancedS (double velocity, double acc, double dec, double jerkAcc, double jerkDec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkLimitedAdvancedS profile set as specified by the function arguments.

static Profile __stdcall SetupJerkLimitedSinusoidalJerk (double velocity, double acc, double dec, double jerkAcc, double jerkDec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkLimitedSinusoidalJerk profile set as specified by the function arguments.

static Profile __stdcall SetupTwoVelocityTrapezoidal (double velocity, double acc, double dec, double secondVelocity, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TwoVelocityTrapezoidal profile set as specified by the function arguments.

static Profile __stdcall SetupTwoVelocitySCurve (double velocity, double acc, double dec, double secondVelocity, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TwoVelocitySCurve profile set as specified by the function arguments.

static Profile __stdcall SetupTwoVelocityJerkRatio (double velocity, double acc, double dec, double jerkAccRatio, double jerkDecRatio, double secondVelocity, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TwoVelocityJerkRatio profile set as specified by the function arguments.

static Profile __stdcall SetupTimeAccTrapezoidal (double velocity, double accTimeMilliseconds, double decTimeMilliseconds, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TimeAccTrapezoidal profile set as specified by the function arguments.

static Profile __stdcall SetupTimeAccSCurve (double velocity, double accTimeMilliseconds, double decTimeMilliseconds, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TimeAccSCurve profile set as specified by the function arguments.

static Profile __stdcall SetupTimeAccJerkRatio (double velocity, double accTimeMilliseconds, double decTimeMilliseconds, double jerkAccRatio, double jerkDecRatio, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TimeAccJerkRatio profile set as specified by the function arguments.

static Profile __stdcall SetupTimeAccParabolic (double velocity, double accTimeMilliseconds, double decTimeMilliseconds, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TimeAccParabolic profile set as specified by the function arguments.

static Profile __stdcall SetupTimeAccSin (double velocity, double accTimeMilliseconds, double decTimeMilliseconds, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TimeAccSin profile set as specified by the function arguments.

static Profile __stdcall SetupTimeAccAdvancedS (double velocity, double accTimeMilliseconds, double decTimeMilliseconds, double jerkAccRatio, double jerkDecRatio, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the TimeAccAdvancedS profile set as specified by the function arguments.

static Profile __stdcall SetupConstantDec (double startingVelocity, double endVelocity): Function that returns an object of this class with the parameters that are used by the ConstantDec profile set as specified by the function arguments.

static Profile __stdcall SetupJerkRatioFixedVelocityT (double velocity, double acc, double dec, double jerkAccRatio, double jerkDecRatio, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkRatioFixedVelocityT profile set as specified by the function arguments.

static Profile __stdcall SetupJerkRatioFixedVelocityS (double velocity, double acc, double dec, double jerkAccRatio, double jerkDecRatio, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkRatioFixedVelocityS profile set as specified by the function arguments.

static Profile __stdcall SetupJerkLimitedFixedVelocityT (double velocity, double acc, double dec, double jerkAcc, double jerkDec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkLimitedFixedVelocityT profile set as specified by the function arguments.

static Profile __stdcall SetupJerkLimitedFixedVelocityS (double velocity, double acc, double dec, double jerkAcc, double jerkDec, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the JerkLimitedFixedVelocityS profile set as specified by the function arguments.

static Profile __stdcall SetupParabolicVelocity (double jerkAccRatio, double jerkDecRatio, double accTimeMilliseconds, double decTimeMilliseconds, double startingVelocity=0, double endVelocity=0): Function that returns an object of this class with the parameters that are used by the ParabolicVelocity profile set as specified by the function arguments.