Detailed Description

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

Specializes BasicVector with specific getters and setters.

#include <src/gen/bicycle_car_parameters.h>

Inheritance diagram for BicycleCarParameters< T >:

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

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

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

	BicycleCarParameters (BicycleCarParameters &&other) noexcept

BicycleCarParameters &	operator= (const BicycleCarParameters &other)

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

BicycleCarParameters< T > *	DoClone () const final

Getters and Setters
const T &	mass () const
	mass More...

void	set_mass (const T &mass)
	Setter that matches mass(). More...

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters< T >	with_mass (const T &mass) const
	Fluent setter that matches mass(). More...

const T &	lf () const
	distance from the center of mass to the front axle More...

void	set_lf (const T &lf)
	Setter that matches lf(). More...

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters< T >	with_lf (const T &lf) const
	Fluent setter that matches lf(). More...

const T &	lr () const
	distance from the center of mass to the rear axle More...

void	set_lr (const T &lr)
	Setter that matches lr(). More...

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters< T >	with_lr (const T &lr) const
	Fluent setter that matches lr(). More...

const T &	Iz () const
	moment of inertia about the yaw-axis More...

void	set_Iz (const T &Iz)
	Setter that matches Iz(). More...

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters< T >	with_Iz (const T &Iz) const
	Fluent setter that matches Iz(). More...

const T &	Cf () const
	cornering stiffness (front) More...

void	set_Cf (const T &Cf)
	Setter that matches Cf(). More...

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters< T >	with_Cf (const T &Cf) const
	Fluent setter that matches Cf(). More...

const T &	Cr () const
	cornering stiffness (rear) More...

void	set_Cr (const T &Cr)
	Setter that matches Cr(). More...

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters< T >	with_Cr (const T &Cr) const
	Fluent setter that matches Cr(). More...

drake::boolean< T >	IsValid () const
	Returns whether the current values of this vector are well-formed. More...

void	GetElementBounds (Eigen::VectorXd lower, Eigen::VectorXd upper) const final

static const std::vector< std::string > &	GetCoordinateNames ()
	See BicycleCarParametersIndices::GetCoordinateNames(). More...

Member Typedef Documentation

◆ K

typedef BicycleCarParametersIndices K

An abbreviation for our row index constants.

Constructor & Destructor Documentation

◆ BicycleCarParameters() [1/3]

BicycleCarParameters ( )

Default constructor.

Sets all rows to their default value:

mass defaults to 2278.0 kg.
lf defaults to 1.292 m.
lr defaults to 1.515 m.
Iz defaults to 3210.0 kg m^2.
Cf defaults to 10.8e4 N / rad.
Cr defaults to 10.8e4 N / rad.

◆ BicycleCarParameters() [2/3]

BicycleCarParameters ( const BicycleCarParameters< T > & other )

◆ BicycleCarParameters() [3/3]

BicycleCarParameters ( BicycleCarParameters< T > && other )

noexcept

Member Function Documentation

◆ Cf()

const T& Cf ( ) const

cornering stiffness (front)

Note: Cf is expressed in units of N / rad.; Cf has a limited domain of [0.0, +Inf].

◆ Cr()

const T& Cr ( ) const

cornering stiffness (rear)

Note: Cr is expressed in units of N / rad.; Cr has a limited domain of [0.0, +Inf].

◆ DoClone()

BicycleCarParameters<T>* DoClone ( ) const

final

◆ GetCoordinateNames()

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

static

See BicycleCarParametersIndices::GetCoordinateNames().

◆ GetElementBounds()

void GetElementBounds	(	Eigen::VectorXd *	lower,
		Eigen::VectorXd *	upper
	)		const

final

◆ IsValid()

drake::boolean<T> IsValid ( ) const

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

◆ Iz()

const T& Iz ( ) const

moment of inertia about the yaw-axis

Note: Iz is expressed in units of kg m^2.; Iz has a limited domain of [0.0, +Inf].

◆ lf()

const T& lf ( ) const

distance from the center of mass to the front axle

Note: lf is expressed in units of m.; lf has a limited domain of [0.0, +Inf].

◆ lr()

const T& lr ( ) const

distance from the center of mass to the rear axle

Note: lr is expressed in units of m.; lr has a limited domain of [0.0, +Inf].

◆ mass()

const T& mass ( ) const

mass

Note: mass is expressed in units of kg.; mass has a limited domain of [0.0, +Inf].

◆ operator=() [1/2]

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

noexcept

◆ operator=() [2/2]

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

◆ set_Cf()

void set_Cf ( const T & Cf )

Setter that matches Cf().

◆ set_Cr()

void set_Cr ( const T & Cr )

Setter that matches Cr().

◆ set_Iz()

void set_Iz ( const T & Iz )

Setter that matches Iz().

◆ set_lf()

void set_lf ( const T & lf )

Setter that matches lf().

◆ set_lr()

void set_lr ( const T & lr )

Setter that matches lr().

◆ set_mass()

void set_mass ( const T & mass )

Setter that matches mass().

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

◆ with_Cf()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters<T> with_Cf ( const T & Cf ) const

Fluent setter that matches Cf().

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

◆ with_Cr()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters<T> with_Cr ( const T & Cr ) const

Fluent setter that matches Cr().

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

◆ with_Iz()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters<T> with_Iz ( const T & Iz ) const

Fluent setter that matches Iz().

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

◆ with_lf()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters<T> with_lf ( const T & lf ) const

Fluent setter that matches lf().

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

◆ with_lr()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters<T> with_lr ( const T & lr ) const

Fluent setter that matches lr().

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

◆ with_mass()

DRAKE_VECTOR_GEN_NODISCARD BicycleCarParameters<T> with_mass ( const T & mass ) const

Fluent setter that matches mass().

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

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

bicycle_car_parameters.h