Detailed Description

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

Specializes BasicVector with specific getters and setters.

#include <src/gen/pure_pursuit_params.h>

Inheritance diagram for PurePursuitParams< T >:

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

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

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

	PurePursuitParams (PurePursuitParams &&other) noexcept

PurePursuitParams &	operator= (const PurePursuitParams &other)

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

PurePursuitParams< T > *	DoClone () const final

Getters and Setters
const T &	s_lookahead () const
	distance along the s-direction to place the reference point More...

void	set_s_lookahead (const T &s_lookahead)
	Setter that matches s_lookahead(). More...

DRAKE_VECTOR_GEN_NODISCARD PurePursuitParams< T >	with_s_lookahead (const T &s_lookahead) const
	Fluent setter that matches s_lookahead(). 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 PurePursuitParamsIndices::GetCoordinateNames(). More...

Member Typedef Documentation

◆ K

typedef PurePursuitParamsIndices K

An abbreviation for our row index constants.

Constructor & Destructor Documentation

◆ PurePursuitParams() [1/3]

PurePursuitParams ( )

Default constructor.

Sets all rows to their default value:

s_lookahead defaults to 15.0 m.

◆ PurePursuitParams() [2/3]

PurePursuitParams ( const PurePursuitParams< T > & other )

◆ PurePursuitParams() [3/3]

PurePursuitParams ( PurePursuitParams< T > && other )

noexcept

Member Function Documentation

◆ DoClone()

PurePursuitParams<T>* DoClone ( ) const

final

◆ GetCoordinateNames()

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

static

See PurePursuitParamsIndices::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.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

noexcept

◆ s_lookahead()

const T& s_lookahead ( ) const

distance along the s-direction to place the reference point

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

◆ set_s_lookahead()

void set_s_lookahead ( const T & s_lookahead )

Setter that matches s_lookahead().

◆ 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_s_lookahead()

DRAKE_VECTOR_GEN_NODISCARD PurePursuitParams<T> with_s_lookahead ( const T & s_lookahead ) const

Fluent setter that matches s_lookahead().

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

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

pure_pursuit_params.h