Detailed Description

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

Specializes BasicVector with specific getters and setters.

#include <src/gen/dynamic_bicycle_car_state.h>

Inheritance diagram for DynamicBicycleCarState< T >:

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

Public Member Functions
	DynamicBicycleCarState ()
	Default constructor. More...

Implements CopyConstructible, CopyAssignable, MoveConstructible,
MoveAssignable
	DynamicBicycleCarState (const DynamicBicycleCarState &other)

	DynamicBicycleCarState (DynamicBicycleCarState &&other) noexcept

DynamicBicycleCarState &	operator= (const DynamicBicycleCarState &other)

DynamicBicycleCarState &	operator= (DynamicBicycleCarState &&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...

DynamicBicycleCarState< T > *	DoClone () const final

Getters and Setters
const T &	p_LoCp_x () const
	Lx measure of the location of Cp from Lo. More...

void	set_p_LoCp_x (const T &p_LoCp_x)
	Setter that matches p_LoCp_x(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState< T >	with_p_LoCp_x (const T &p_LoCp_x) const
	Fluent setter that matches p_LoCp_x(). More...

const T &	p_LoCp_y () const
	Ly measure of the location of Cp from Lo. More...

void	set_p_LoCp_y (const T &p_LoCp_y)
	Setter that matches p_LoCp_y(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState< T >	with_p_LoCp_y (const T &p_LoCp_y) const
	Fluent setter that matches p_LoCp_y(). More...

const T &	yaw_LC () const
	Yaw angle from Lx to Cx with positive Lz sense. More...

void	set_yaw_LC (const T &yaw_LC)
	Setter that matches yaw_LC(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState< T >	with_yaw_LC (const T &yaw_LC) const
	Fluent setter that matches yaw_LC(). More...

const T &	v_LCp_x () const
	Cx measure of Cp's velocity in L. More...

void	set_v_LCp_x (const T &v_LCp_x)
	Setter that matches v_LCp_x(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState< T >	with_v_LCp_x (const T &v_LCp_x) const
	Fluent setter that matches v_LCp_x(). More...

const T &	v_LCp_y () const
	Cy measure of Cp's velocity in L. More...

void	set_v_LCp_y (const T &v_LCp_y)
	Setter that matches v_LCp_y(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState< T >	with_v_LCp_y (const T &v_LCp_y) const
	Fluent setter that matches v_LCp_y(). More...

const T &	yawDt_LC () const
	C's angular velocity in frame L. More...

void	set_yawDt_LC (const T &yawDt_LC)
	Setter that matches yawDt_LC(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState< T >	with_yawDt_LC (const T &yawDt_LC) const
	Fluent setter that matches yawDt_LC(). 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 DynamicBicycleCarStateIndices::GetCoordinateNames(). More...

Member Typedef Documentation

◆ K

typedef DynamicBicycleCarStateIndices K

An abbreviation for our row index constants.

Constructor & Destructor Documentation

◆ DynamicBicycleCarState() [1/3]

DynamicBicycleCarState ( )

Default constructor.

Sets all rows to their default value:

p_LoCp_x defaults to 0.0 m.
p_LoCp_y defaults to 0.0 m.
yaw_LC defaults to 0.0 rad.
v_LCp_x defaults to 0.0 m/s.
v_LCp_y defaults to 0.0 m/s.
yawDt_LC defaults to 0.0 rad/s.

◆ DynamicBicycleCarState() [2/3]

DynamicBicycleCarState ( const DynamicBicycleCarState< T > & other )

◆ DynamicBicycleCarState() [3/3]

DynamicBicycleCarState ( DynamicBicycleCarState< T > && other )

noexcept

Member Function Documentation

◆ DoClone()

DynamicBicycleCarState<T>* DoClone ( ) const

final

◆ GetCoordinateNames()

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

static

See DynamicBicycleCarStateIndices::GetCoordinateNames().

◆ IsValid()

drake::boolean<T> IsValid ( ) const

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

◆ operator=() [1/2]

DynamicBicycleCarState& operator= ( const DynamicBicycleCarState< T > & other )

◆ operator=() [2/2]

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

noexcept

◆ p_LoCp_x()

const T& p_LoCp_x ( ) const

Lx measure of the location of Cp from Lo.

Note: p_LoCp_x is expressed in units of m.

◆ p_LoCp_y()

const T& p_LoCp_y ( ) const

Ly measure of the location of Cp from Lo.

Note: p_LoCp_y is expressed in units of m.

◆ set_p_LoCp_x()

void set_p_LoCp_x ( const T & p_LoCp_x )

Setter that matches p_LoCp_x().

◆ set_p_LoCp_y()

void set_p_LoCp_y ( const T & p_LoCp_y )

Setter that matches p_LoCp_y().

◆ set_v_LCp_x()

void set_v_LCp_x ( const T & v_LCp_x )

Setter that matches v_LCp_x().

◆ set_v_LCp_y()

void set_v_LCp_y ( const T & v_LCp_y )

Setter that matches v_LCp_y().

◆ set_yaw_LC()

void set_yaw_LC ( const T & yaw_LC )

Setter that matches yaw_LC().

◆ set_yawDt_LC()

void set_yawDt_LC ( const T & yawDt_LC )

Setter that matches yawDt_LC().

◆ 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.

◆ v_LCp_x()

const T& v_LCp_x ( ) const

Cx measure of Cp's velocity in L.

Note: v_LCp_x is expressed in units of m/s.

◆ v_LCp_y()

const T& v_LCp_y ( ) const

Cy measure of Cp's velocity in L.

Note: v_LCp_y is expressed in units of m/s.

◆ with_p_LoCp_x()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState<T> with_p_LoCp_x ( const T & p_LoCp_x ) const

Fluent setter that matches p_LoCp_x().

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

◆ with_p_LoCp_y()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState<T> with_p_LoCp_y ( const T & p_LoCp_y ) const

Fluent setter that matches p_LoCp_y().

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

◆ with_v_LCp_x()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState<T> with_v_LCp_x ( const T & v_LCp_x ) const

Fluent setter that matches v_LCp_x().

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

◆ with_v_LCp_y()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState<T> with_v_LCp_y ( const T & v_LCp_y ) const

Fluent setter that matches v_LCp_y().

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

◆ with_yaw_LC()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState<T> with_yaw_LC ( const T & yaw_LC ) const

Fluent setter that matches yaw_LC().

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

◆ with_yawDt_LC()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarState<T> with_yawDt_LC ( const T & yawDt_LC ) const

Fluent setter that matches yawDt_LC().

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

◆ yaw_LC()

const T& yaw_LC ( ) const

Yaw angle from Lx to Cx with positive Lz sense.

Note: yaw_LC is expressed in units of rad.

◆ yawDt_LC()

const T& yawDt_LC ( ) const

C's angular velocity in frame L.

Note: yawDt_LC is expressed in units of rad/s.

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

dynamic_bicycle_car_state.h