delphyne
MobilPlannerParameters< T > Class Template Referencefinal

Detailed Description

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

Specializes BasicVector with specific getters and setters.

#include <src/gen/mobil_planner_parameters.h>

Inheritance diagram for MobilPlannerParameters< T >:
[legend]

Public Types

typedef MobilPlannerParametersIndices K
 An abbreviation for our row index constants. More...
 

Public Member Functions

 MobilPlannerParameters ()
 Default constructor. More...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible,

MoveAssignable

 MobilPlannerParameters (const MobilPlannerParameters &other)
 
 MobilPlannerParameters (MobilPlannerParameters &&other) noexcept
 
MobilPlannerParametersoperator= (const MobilPlannerParameters &other)
 
MobilPlannerParametersoperator= (MobilPlannerParameters &&other) noexcept
 
template<typename U = T>
std::enable_if< std::is_same< U, drake::symbolic::Expression >::value >::type SetToNamedVariables ()
 Create a symbolic::Variable for each element with the known variable name. More...
 
MobilPlannerParameters< T > * DoClone () const final
 

Getters and Setters

const T & p () const
 politeness factor (0.0 is purely egoistic, higher values increase politeness) More...
 
void set_p (const T &p)
 Setter that matches p(). More...
 
DRAKE_VECTOR_GEN_NODISCARD MobilPlannerParameters< T > with_p (const T &p) const
 Fluent setter that matches p(). More...
 
const T & threshold () const
 acceleration threshold for changing lanes (Delta_a_th) More...
 
void set_threshold (const T &threshold)
 Setter that matches threshold(). More...
 
DRAKE_VECTOR_GEN_NODISCARD MobilPlannerParameters< T > with_threshold (const T &threshold) const
 Fluent setter that matches threshold(). More...
 
const T & max_deceleration () const
 maximum safe deceleration (b_safe) More...
 
void set_max_deceleration (const T &max_deceleration)
 Setter that matches max_deceleration(). More...
 
DRAKE_VECTOR_GEN_NODISCARD MobilPlannerParameters< T > with_max_deceleration (const T &max_deceleration) const
 Fluent setter that matches max_deceleration(). 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 MobilPlannerParametersIndices::GetCoordinateNames(). More...
 

Member Typedef Documentation

◆ K

An abbreviation for our row index constants.

Constructor & Destructor Documentation

◆ MobilPlannerParameters() [1/3]

Default constructor.

Sets all rows to their default value:

  • p defaults to 0.5 dimensionless.
  • threshold defaults to 0.1 m/s^2.
  • max_deceleration defaults to 4.0 m/s^2.

◆ MobilPlannerParameters() [2/3]

◆ MobilPlannerParameters() [3/3]

MobilPlannerParameters ( MobilPlannerParameters< T > &&  other)
noexcept

Member Function Documentation

◆ DoClone()

MobilPlannerParameters<T>* DoClone ( ) const
final

◆ GetCoordinateNames()

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

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

◆ max_deceleration()

const T& max_deceleration ( ) const

maximum safe deceleration (b_safe)

Note
max_deceleration is expressed in units of m/s^2.
max_deceleration has a limited domain of [0.0, +Inf].

◆ operator=() [1/2]

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

◆ operator=() [2/2]

MobilPlannerParameters& operator= ( MobilPlannerParameters< T > &&  other)
noexcept

◆ p()

const T& p ( ) const

politeness factor (0.0 is purely egoistic, higher values increase politeness)

Note
p is expressed in units of dimensionless.
p has a limited domain of [0.0, 1.0].

◆ set_max_deceleration()

void set_max_deceleration ( const T &  max_deceleration)

Setter that matches max_deceleration().

◆ set_p()

void set_p ( const T &  p)

Setter that matches p().

◆ set_threshold()

void set_threshold ( const T &  threshold)

Setter that matches threshold().

◆ SetToNamedVariables()

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

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

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

◆ threshold()

const T& threshold ( ) const

acceleration threshold for changing lanes (Delta_a_th)

Note
threshold is expressed in units of m/s^2.
threshold has a limited domain of [0.0, +Inf].

◆ with_max_deceleration()

DRAKE_VECTOR_GEN_NODISCARD MobilPlannerParameters<T> with_max_deceleration ( const T &  max_deceleration) const

Fluent setter that matches max_deceleration().

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

◆ with_p()

DRAKE_VECTOR_GEN_NODISCARD MobilPlannerParameters<T> with_p ( const T &  p) const

Fluent setter that matches p().

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

◆ with_threshold()

DRAKE_VECTOR_GEN_NODISCARD MobilPlannerParameters<T> with_threshold ( const T &  threshold) const

Fluent setter that matches threshold().

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


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