pilot Namespace Reference

Classes
class	AccelBase
class	AccelExample
class	AccelPlan
class	AccelSpeed
Typedefs
typedef boost::shared_ptr < AccelBase >	AccelBasePtr
Functions
AccelBasePtr	allocAccel (art_pilot::PilotConfig &config)
static float	clamp (float lower, float value, float upper)
static float	signum (float value)

---

Typedef Documentation

typedef boost::shared_ptr<AccelBase> pilot::AccelBasePtr

Shared point to AccelBase instance.

Definition at line 67 of file accel.h.

---

Function Documentation

boost::shared_ptr< AccelBase > pilot::allocAccel

(

art_pilot::PilotConfig &

config

)

Allocate a new acceleration controller.

Parameters:

[in,out]

config

latest pilot configuration parameters (may be modified if parameter values invalid)

Returns:

boost shared pointer to acceleration controller object

allocate an acceleration controller instance

Parameters:

config

current Pilot configuration parameters

Returns:

boost shared pointer to a newly allocated controller

Definition at line 33 of file alloc_accel.cc.

static float pilot::clamp	(	float	lower,
		float	value,
		float	upper
	)		[inline, static]

Clamp value to range.

minimum value of range data to compare maximum value of range

Returns:

value unless it is outside [lower, upper]; or the nearest limit, otherwise.

Definition at line 85 of file accel.h.

static float pilot::signum

(

float

value

)

[inline, static]

Signum (sign) of a value.

data to compare

Returns:

1.0 if value is positive, 0.0 if zero, -1.0 if negative.

Definition at line 95 of file accel.h.