Detailed Description

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

Specializes BasicVector with specific getters and setters that specify the continuous state for a RailFollower system.

#include <src/gen/rail_follower_state.h>

Inheritance diagram for RailFollowerState< T >:

Public Member Functions
Implements CopyConstructible, CopyAssignable, MoveConstructible,
MoveAssignable
	RailFollowerState (const RailFollowerState &other)

	RailFollowerState (RailFollowerState &&other) noexcept

RailFollowerState &	operator= (const RailFollowerState &other)

RailFollowerState &	operator= (RailFollowerState &&other) noexcept

template<typename U = T>
std::enable_if< std::is_same< U, Symbolic >::value >::type	SetToNamedVariables ()
	Create a symbolic::Variable for each element with the known variable name. More...

RailFollowerState< T > *	DoClone () const final

Vector indices.
	RailFollowerState ()
	Initialise the vector with defaults. More...

Getters and Setters
const T &	s () const
	The longitudinal position along the current rail (m). More...

void	set_s (const T &s)
	Setter that matches s(). More...

DRAKE_VECTOR_GEN_NODISCARD RailFollowerState< T >	with_s (const T &s) const
	Fluent setter that matches s(). More...

const T &	speed () const
	The speed of the vehicle in physical space (not nec. rail speed) (m/s). More...

void	set_speed (const T &speed)
	Setter that matches speed(). More...

DRAKE_VECTOR_GEN_NODISCARD RailFollowerState< T >	with_speed (const T &speed) const
	Fluent setter that matches speed(). More...

std::string	ToString () const
	Verbose string representation. More...

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

Constructor & Destructor Documentation

◆ RailFollowerState() [1/3]

RailFollowerState ( )

Initialise the vector with defaults.

◆ RailFollowerState() [2/3]

RailFollowerState ( const RailFollowerState< T > & other )

◆ RailFollowerState() [3/3]

RailFollowerState ( RailFollowerState< T > && other )

noexcept

Member Function Documentation

◆ DoClone()

RailFollowerState<T>* DoClone ( ) const

final

◆ IsValid()

drake::boolean<T> IsValid ( ) const

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

noexcept

◆ s()

const T& s ( ) const

The longitudinal position along the current rail (m).

◆ set_s()

void set_s ( const T & s )

Setter that matches s().

◆ set_speed()

void set_speed ( const T & speed )

Setter that matches speed().

◆ SetToNamedVariables()

std::enable_if<std::is_same<U, Symbolic>::value>::type SetToNamedVariables ( )

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

This is only available for T == delphyne::Symbolic.

◆ speed()

const T& speed ( ) const

The speed of the vehicle in physical space (not nec. rail speed) (m/s).

◆ ToString()

std::string ToString ( ) const

Verbose string representation.

◆ with_s()

DRAKE_VECTOR_GEN_NODISCARD RailFollowerState<T> with_s ( const T & s ) const

Fluent setter that matches s().

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

◆ with_speed()

DRAKE_VECTOR_GEN_NODISCARD RailFollowerState<T> with_speed ( const T & speed ) const

Fluent setter that matches speed().

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

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