Detailed Description

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

Specializes BasicVector with specific getters and setters.

#include <src/gen/dynamic_bicycle_car_input.h>

Inheritance diagram for DynamicBicycleCarInput< T >:

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

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

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

	DynamicBicycleCarInput (DynamicBicycleCarInput &&other) noexcept

DynamicBicycleCarInput &	operator= (const DynamicBicycleCarInput &other)

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

DynamicBicycleCarInput< T > *	DoClone () const final

Getters and Setters
const T &	steer_CD () const
	Steer angle from Cx to Dx with positive Cz sense. More...

void	set_steer_CD (const T &steer_CD)
	Setter that matches steer_CD(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarInput< T >	with_steer_CD (const T &steer_CD) const
	Fluent setter that matches steer_CD(). More...

const T &	f_Cp_x () const
	The Cx measure of the Longitudinal force on body C at Cp. More...

void	set_f_Cp_x (const T &f_Cp_x)
	Setter that matches f_Cp_x(). More...

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarInput< T >	with_f_Cp_x (const T &f_Cp_x) const
	Fluent setter that matches f_Cp_x(). 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 DynamicBicycleCarInputIndices::GetCoordinateNames(). More...

Member Typedef Documentation

◆ K

typedef DynamicBicycleCarInputIndices K

An abbreviation for our row index constants.

Constructor & Destructor Documentation

◆ DynamicBicycleCarInput() [1/3]

DynamicBicycleCarInput ( )

Default constructor.

Sets all rows to their default value:

steer_CD defaults to 0.0 rad.
f_Cp_x defaults to 0.0 N.

◆ DynamicBicycleCarInput() [2/3]

DynamicBicycleCarInput ( const DynamicBicycleCarInput< T > & other )

◆ DynamicBicycleCarInput() [3/3]

DynamicBicycleCarInput ( DynamicBicycleCarInput< T > && other )

noexcept

Member Function Documentation

◆ DoClone()

DynamicBicycleCarInput<T>* DoClone ( ) const

final

◆ f_Cp_x()

const T& f_Cp_x ( ) const

The Cx measure of the Longitudinal force on body C at Cp.

Note: f_Cp_x is expressed in units of N.

◆ GetCoordinateNames()

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

static

See DynamicBicycleCarInputIndices::GetCoordinateNames().

◆ IsValid()

drake::boolean<T> IsValid ( ) const

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

noexcept

◆ set_f_Cp_x()

void set_f_Cp_x ( const T & f_Cp_x )

Setter that matches f_Cp_x().

◆ set_steer_CD()

void set_steer_CD ( const T & steer_CD )

Setter that matches steer_CD().

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

◆ steer_CD()

const T& steer_CD ( ) const

Steer angle from Cx to Dx with positive Cz sense.

Note: steer_CD is expressed in units of rad.

◆ with_f_Cp_x()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarInput<T> with_f_Cp_x ( const T & f_Cp_x ) const

Fluent setter that matches f_Cp_x().

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

◆ with_steer_CD()

DRAKE_VECTOR_GEN_NODISCARD DynamicBicycleCarInput<T> with_steer_CD ( const T & steer_CD ) const

Fluent setter that matches steer_CD().

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

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

dynamic_bicycle_car_input.h