SiMoPoly.IPoly Interface Reference

Interface to a single polynomial function. More...

Public Member Functions
bool	DefineWithConstraints ()
	Define the polynomial function with the X and Y space and the derivative values at the start and at the end point, if you want to shift the polynomial in Y direction just set Factor[0].
bool	DefineWithFactors ()
	Define the polynomial function with the factors resp. coefficients, be sure to also set the space sX of the polynomial function in X direction.
bool	EvaluateMinMax ()
	Evaluate the minima and maxima of the polynomial function, i.e. sMin and sMax are calculated automatically.
bool	EvaluateExtrema ()
	Evaluate the minima and maxima of the derivatives of the polynomial function, i.e. vMin, vMax, aMin, aMax, jMin and jMax are calculated automatically.
bool	Integrate ()
	Integrate the polynomial.

Properties
PolyGrades	Grade [get, set]
	Grade of the polynomial function.
double[]	Factor [get, set]
	Factors resp. coefficients of the polynomial function, when DefineWithConstraints() is used they will be automatically calculated.
double	sX [get, set]
	Space of the polynomial function in X direction, must not be zero.
double	sY [get, set]
	Space of the polynomial function in Y direction, must not be zero.
double	vStart [get, set]
	'Velocity' of the polynomial function, i.e. dY/dX, at the start point
double	vEnd [get, set]
	'Velocity' of the polynomial function, i.e. dY/dX, at the end point
double	aStart [get, set]
	'Acceleration' of the polynomial function, i.e. d^2Y/dX^2, at the start point
double	aEnd [get, set]
	'Acceleration' of the polynomial function, i.e. d^2Y/dX^2, at the end point
double	jStart [get, set]
	'Jerk' of the polynomial function, i.e. d^3Y/dX^3, at the start point
double	jEnd [get, set]
	'Jerk' of the polynomial function, i.e. d^3Y/dX^3, at the end point
double	X [get, set]
	Defines the X value in order to evaluate the polynomial function.
double	pX [get]
	Evaluated space value of the polynomial function in Y direction after writing space value X.
double	vX [get]
	Evaluated 'velocity' value, i.e. dY/dX, of the polynomial function after writing space value X.
double	aX [get]
	Evaluated 'acceleration' value, i.e. d^2Y/dX^2 of the polynomial function after writing space value X.
double	jX [get]
	Evaluated 'jerk' value, i.e. d^3Y/dX^3 of the polynomial function after writing space value X.
double	sMin [get]
	Minimum space value of the polynomial function in Y direction after applying EvaluateMinMax().
double	sMax [get]
	Maximum space value of the polynomial function in Y direction after applying EvaluateMinMax().
double	vMin [get]
	Minimum 'velocity' value, i.e. dY/dX, of the polynomial function after applying EvaluateExtrema().
double	vMax [get]
	Maximum 'velocity' value, i.e. dY/dX, of the polynomial function after applying EvaluateExtrema().
double	aMin [get]
	Minimum 'acceleration' value, i.e. d^2Y/dX^2, of the polynomial function after applying EvaluateExtrema().
double	aMax [get]
	Maximum 'acceleration' value, i.e. d^2Y/dX^2, of the polynomial function after applying EvaluateExtrema().
bool	aCapped [get, set]
	If set to TRUE a Poly7, Poly9 or Poly11 is calculated, which tries to cap the maximum 'acceleration'.
double	jMin [get]
	Minimum 'jerk' value, i.e. d^3Y/dX^3, of the polynomial function after applying EvaluateExtrema().
double	jMax [get]
	Maximum 'jerk' value, i.e. d^3Y/dX^3, of the polynomial function after applying EvaluateExtrema().
bool	auto_define [get, set]
	If set to TRUE the function DefineWithConstraints() is automatically called before polynomial evaluaten and before EvaluateMinMax() or EvaluateExtrema() are executed.
string	LicenseKey [get, set]
	To input a Developer or Developer Deploy license string, when read the hardware or software license is stated.
string	LicenseKeyStacker [get, set]
	To input a Stacker Developer or Stacker Developer Deploy license string, when read the hardware or software license is stated.

Detailed Description

Interface to a single polynomial function.

Member Function Documentation

DefineWithConstraints()

bool SiMoPoly.IPoly.DefineWithConstraints

(

)

Define the polynomial function with the X and Y space and the derivative values at the start and at the end point, if you want to shift the polynomial in Y direction just set Factor[0].

DefineWithFactors()

bool SiMoPoly.IPoly.DefineWithFactors

(

)

Define the polynomial function with the factors resp. coefficients, be sure to also set the space sX of the polynomial function in X direction.

EvaluateExtrema()

bool SiMoPoly.IPoly.EvaluateExtrema

(

)

Evaluate the minima and maxima of the derivatives of the polynomial function, i.e. vMin, vMax, aMin, aMax, jMin and jMax are calculated automatically.

EvaluateMinMax()

bool SiMoPoly.IPoly.EvaluateMinMax

(

)

Evaluate the minima and maxima of the polynomial function, i.e. sMin and sMax are calculated automatically.

Integrate()

bool SiMoPoly.IPoly.Integrate

(

)

Integrate the polynomial.

Property Documentation

aCapped

bool SiMoPoly.IPoly.aCapped

getset

If set to TRUE a Poly7, Poly9 or Poly11 is calculated, which tries to cap the maximum 'acceleration'.

Default value is FALSE

aEnd

double SiMoPoly.IPoly.aEnd

getset

'Acceleration' of the polynomial function, i.e. d^2Y/dX^2, at the end point

Default value is 0.0

aMax

double SiMoPoly.IPoly.aMax

get

Maximum 'acceleration' value, i.e. d^2Y/dX^2, of the polynomial function after applying EvaluateExtrema().

aMin

double SiMoPoly.IPoly.aMin

get

Minimum 'acceleration' value, i.e. d^2Y/dX^2, of the polynomial function after applying EvaluateExtrema().

aStart

double SiMoPoly.IPoly.aStart

getset

'Acceleration' of the polynomial function, i.e. d^2Y/dX^2, at the start point

Default value is 0.0

auto_define

bool SiMoPoly.IPoly.auto_define

getset

If set to TRUE the function DefineWithConstraints() is automatically called before polynomial evaluaten and before EvaluateMinMax() or EvaluateExtrema() are executed.

Default value is TRUE

aX

double SiMoPoly.IPoly.aX

get

Evaluated 'acceleration' value, i.e. d^2Y/dX^2 of the polynomial function after writing space value X.

Factor

double [] SiMoPoly.IPoly.Factor

getset

Factors resp. coefficients of the polynomial function, when DefineWithConstraints() is used they will be automatically calculated.

Grade

PolyGrades SiMoPoly.IPoly.Grade

getset

Grade of the polynomial function.

Default value is PolyGrades.Poly3

jEnd

double SiMoPoly.IPoly.jEnd

getset

'Jerk' of the polynomial function, i.e. d^3Y/dX^3, at the end point

Default value is 0.0

jMax

double SiMoPoly.IPoly.jMax

get

Maximum 'jerk' value, i.e. d^3Y/dX^3, of the polynomial function after applying EvaluateExtrema().

jMin

double SiMoPoly.IPoly.jMin

get

Minimum 'jerk' value, i.e. d^3Y/dX^3, of the polynomial function after applying EvaluateExtrema().

jStart

double SiMoPoly.IPoly.jStart

getset

'Jerk' of the polynomial function, i.e. d^3Y/dX^3, at the start point

Default value is 0.0

jX

double SiMoPoly.IPoly.jX

get

Evaluated 'jerk' value, i.e. d^3Y/dX^3 of the polynomial function after writing space value X.

LicenseKey

string SiMoPoly.IPoly.LicenseKey

getset

To input a Developer or Developer Deploy license string, when read the hardware or software license is stated.

LicenseKeyStacker

string SiMoPoly.IPoly.LicenseKeyStacker

getset

To input a Stacker Developer or Stacker Developer Deploy license string, when read the hardware or software license is stated.

pX

double SiMoPoly.IPoly.pX

get

Evaluated space value of the polynomial function in Y direction after writing space value X.

sMax

double SiMoPoly.IPoly.sMax

get

Maximum space value of the polynomial function in Y direction after applying EvaluateMinMax().

sMin

double SiMoPoly.IPoly.sMin

get

Minimum space value of the polynomial function in Y direction after applying EvaluateMinMax().

sX

double SiMoPoly.IPoly.sX

getset

Space of the polynomial function in X direction, must not be zero.

Default value is 100.0

sY

double SiMoPoly.IPoly.sY

getset

Space of the polynomial function in Y direction, must not be zero.

Default value is 100.0

vEnd

double SiMoPoly.IPoly.vEnd

getset

'Velocity' of the polynomial function, i.e. dY/dX, at the end point

Default value is 0.0

vMax

double SiMoPoly.IPoly.vMax

get

Maximum 'velocity' value, i.e. dY/dX, of the polynomial function after applying EvaluateExtrema().

vMin

double SiMoPoly.IPoly.vMin

get

Minimum 'velocity' value, i.e. dY/dX, of the polynomial function after applying EvaluateExtrema().

vStart

double SiMoPoly.IPoly.vStart

getset

'Velocity' of the polynomial function, i.e. dY/dX, at the start point

Default value is 0.0

vX

double SiMoPoly.IPoly.vX

get

Evaluated 'velocity' value, i.e. dY/dX, of the polynomial function after writing space value X.

X

double SiMoPoly.IPoly.X

getset

Defines the X value in order to evaluate the polynomial function.