BicycleCarState< T > Class Template Reference

Detailed Description

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

Specializes BasicVector with specific getters and setters.

#include <src/gen/bicycle_car_state.h>

Inheritance diagram for BicycleCarState< T >:

Public Types
typedef BicycleCarStateIndices	K
	An abbreviation for our row index constants. More...

Public Member Functions
	BicycleCarState ()
	Default constructor. More...
Implements CopyConstructible, CopyAssignable, MoveConstructible,
MoveAssignable
	BicycleCarState (const BicycleCarState &other)
	BicycleCarState (BicycleCarState &&other) noexcept
BicycleCarState &	operator= (const BicycleCarState &other)
BicycleCarState &	operator= (BicycleCarState &&other) noexcept
template<typename U = T>
std::enable_if< std::is_same< U, drake::symbolic::Expression >::value >::type	SetToNamedVariables ()
	Create a drake::symbolic::Variable for each element with the known variable name. More...
BicycleCarState< T > *	DoClone () const final

Getters and Setters
const T &	Psi () const
	yaw angle More...
void	set_Psi (const T &Psi)
	Setter that matches Psi(). More...
DRAKE_VECTOR_GEN_NODISCARD BicycleCarState< T >	with_Psi (const T &Psi) const
	Fluent setter that matches Psi(). More...
const T &	Psi_dot () const
	yaw angular rate More...
void	set_Psi_dot (const T &Psi_dot)
	Setter that matches Psi_dot(). More...
DRAKE_VECTOR_GEN_NODISCARD BicycleCarState< T >	with_Psi_dot (const T &Psi_dot) const
	Fluent setter that matches Psi_dot(). More...
const T &	beta () const
	slip angle at the center of mass More...
void	set_beta (const T &beta)
	Setter that matches beta(). More...
DRAKE_VECTOR_GEN_NODISCARD BicycleCarState< T >	with_beta (const T &beta) const
	Fluent setter that matches beta(). More...
const T &	vel () const
	velocity magnitude More...
void	set_vel (const T &vel)
	Setter that matches vel(). More...
DRAKE_VECTOR_GEN_NODISCARD BicycleCarState< T >	with_vel (const T &vel) const
	Fluent setter that matches vel(). More...
const T &	sx () const
	x-position at the center of mass More...
void	set_sx (const T &sx)
	Setter that matches sx(). More...
DRAKE_VECTOR_GEN_NODISCARD BicycleCarState< T >	with_sx (const T &sx) const
	Fluent setter that matches sx(). More...
const T &	sy () const
	y-position at the center of mass More...
void	set_sy (const T &sy)
	Setter that matches sy(). More...
DRAKE_VECTOR_GEN_NODISCARD BicycleCarState< T >	with_sy (const T &sy) const
	Fluent setter that matches sy(). More...
drake::boolean< T >	IsValid () const
	Returns whether the current values of this vector are well-formed. More...
static const std::vector< std::string > &	GetCoordinateNames ()
	See BicycleCarStateIndices::GetCoordinateNames(). More...

Member Typedef Documentation

K

typedef BicycleCarStateIndices K

An abbreviation for our row index constants.

Constructor & Destructor Documentation

BicycleCarState() [1/3]

BicycleCarState

(

)

Default constructor.

Sets all rows to their default value:

• Psi defaults to 0.0 with unknown units.
• Psi_dot defaults to 0.0 with unknown units.
• beta defaults to 0.0 with unknown units.
• vel defaults to 0.0 with unknown units.
• sx defaults to 0.0 with unknown units.
• sy defaults to 0.0 with unknown units.

BicycleCarState() [2/3]

BicycleCarState

(

const BicycleCarState< T > &

other

)

BicycleCarState() [3/3]

BicycleCarState ( BicycleCarState< T > &&  other )

noexcept

Member Function Documentation

beta()

const T& beta

(

)

const

slip angle at the center of mass

DoClone()

BicycleCarState<T>* DoClone ( ) const

final

GetCoordinateNames()

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

static

See BicycleCarStateIndices::GetCoordinateNames().

IsValid()

drake::boolean<T> IsValid

(

)

const

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

operator=() [1/2]

BicycleCarState& operator= ( BicycleCarState< T > &&  other )

noexcept

operator=() [2/2]

BicycleCarState& operator=

(

const BicycleCarState< T > &

other

)

Psi()

const T& Psi

(

)

const

yaw angle

Psi_dot()

const T& Psi_dot

(

)

const

yaw angular rate

set_beta()

void set_beta

(

const T &

beta

)

Setter that matches beta().

set_Psi()

void set_Psi

(

const T &

Psi

)

Setter that matches Psi().

set_Psi_dot()

void set_Psi_dot

(

const T &

Psi_dot

)

Setter that matches Psi_dot().

set_sx()

void set_sx

(

const T &

sx

)

Setter that matches sx().

set_sy()

void set_sy

(

const T &

sy

)

Setter that matches sy().

set_vel()

void set_vel

(

const T &

vel

)

Setter that matches vel().

SetToNamedVariables()

std::enable_if<std::is_same<U, drake::symbolic::Expression>::value>::type SetToNamedVariables

(

)

Create a drake::symbolic::Variable for each element with the known variable name.

This is only available for T == drake::symbolic::Expression.

sx()

const T& sx

(

)

const

x-position at the center of mass

sy()

const T& sy

(

)

const

y-position at the center of mass

vel()

const T& vel

(

)

const

velocity magnitude

with_beta()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarState<T> with_beta

(

const T &

beta

)

const

Fluent setter that matches beta().

Returns a copy of this with beta set to a new value.

with_Psi()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarState<T> with_Psi

(

const T &

Psi

)

const

Fluent setter that matches Psi().

Returns a copy of this with Psi set to a new value.

with_Psi_dot()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarState<T> with_Psi_dot

(

const T &

Psi_dot

)

const

Fluent setter that matches Psi_dot().

Returns a copy of this with Psi_dot set to a new value.

with_sx()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarState<T> with_sx

(

const T &

sx

)

const

Fluent setter that matches sx().

Returns a copy of this with sx set to a new value.

with_sy()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarState<T> with_sy

(

const T &

sy

)

const

Fluent setter that matches sy().

Returns a copy of this with sy set to a new value.

with_vel()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarState<T> with_vel

(

const T &

vel

)

const

Fluent setter that matches vel().

Returns a copy of this with vel set to a new value.

---

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

• bicycle_car_state.h