AngularRateAccelerationCommand< T > Class Template Reference

Detailed Description

template<typename T>
class delphyne::AngularRateAccelerationCommand< T >

Specializes BasicVector with specific getters and setters.

#include <src/gen/angular_rate_acceleration_command.h>

Inheritance diagram for AngularRateAccelerationCommand< T >:

Public Member Functions
	AngularRateAccelerationCommand ()
	Default constructor. More...
AngularRateAccelerationCommand< T > *	DoClone () const final

Getters and Setters
const T &	angular_rate () const
	The desired angular rate; positive results in the vehicle turning left. More...
void	set_angular_rate (const T &angular_rate)
const T &	acceleration () const
	The signed acceleration, positive means speed up; negative means slow down, but should not move in reverse. More...
void	set_acceleration (const T &acceleration)
bool	IsValid () const
	Returns whether the current values of this vector are well-formed. More...
static int	num_coordinates ()
static int	index_angular_rate ()
static int	index_acceleration ()
static const std::vector< std::string > &	GetCoordinateNames ()
	Returns a vector containing the names of each coordinate within this class. More...

Constructor & Destructor Documentation

AngularRateAccelerationCommand()

AngularRateAccelerationCommand

(

)

Default constructor.

Sets all rows to their default value:

• angular_rate defaults to 0.0 rad/s.
• acceleration defaults to 0.0 m/s^2.

Member Function Documentation

acceleration()

const T& acceleration

(

)

const

The signed acceleration, positive means speed up; negative means slow down, but should not move in reverse.

Note

acceleration is expressed in units of m/s^2.

angular_rate()

const T& angular_rate

(

)

const

The desired angular rate; positive results in the vehicle turning left.

Note

angular_rate is expressed in units of rad/s.

DoClone()

AngularRateAccelerationCommand<T>* DoClone ( ) const

final

GetCoordinateNames()

static const std::vector<std::string>& GetCoordinateNames ( )

static

Returns a vector containing the names of each coordinate within this class.

The indices within the returned vector matches that of this class. In other words, GetCoordinateNames()[i] is the name for BasicVector::GetAtIndex(i).

index_acceleration()

static int index_acceleration ( )

static

index_angular_rate()

static int index_angular_rate ( )

static

IsValid()

bool IsValid

(

)

const

Returns whether the current values of this vector are well-formed.

num_coordinates()

static int num_coordinates ( )

static

set_acceleration()

void set_acceleration

(

const T &

acceleration

)

set_angular_rate()

void set_angular_rate

(

const T &

angular_rate

)

---

The documentation for this class was generated from the following file:

• angular_rate_acceleration_command.h