Drake
MaliputRailcarParams< T > Class Template Reference

Specializes BasicVector with specific getters and setters. More...

#include <drake/automotive/gen/maliput_railcar_params.h>

Inheritance diagram for MaliputRailcarParams< T >:
[legend]
Collaboration diagram for MaliputRailcarParams< T >:
[legend]

Public Types

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

Public Member Functions

 MaliputRailcarParams ()
 Default constructor. More...
 
MaliputRailcarParams< T > * DoClone () const override
 Returns a new BasicVector containing a copy of the entire vector. More...
 
decltype(T()< T()) IsValid () const
 Returns whether the current values of this vector are well-formed. More...
 
Getters and Setters
const T & r () const
 The vehicle's position on the lane's r-axis. More...
 
void set_r (const T &r)
 
const T & h () const
 The vehicle's height above the lane's surface. More...
 
void set_h (const T &h)
 
const T & max_speed () const
 The limit on the vehicle's forward speed, in meters per second; this element must be positive. More...
 
void set_max_speed (const T &max_speed)
 
const T & velocity_limit_kp () const
 The smoothing constant for min/max velocity limits; this element must be positive. More...
 
void set_velocity_limit_kp (const T &velocity_limit_kp)
 
- Public Member Functions inherited from BasicVector< T >
 BasicVector (int size)
 Initializes with the given size using the drake::dummy_value<T>, which is NaN when T = double. More...
 
 BasicVector (const VectorX< T > &data)
 Constructs a BasicVector with the specified data. More...
 
int size () const override
 Returns the number of elements in the vector. More...
 
void set_value (const Eigen::Ref< const VectorX< T >> &value)
 Sets the vector to the given value. More...
 
Eigen::VectorBlock< const VectorX< T > > get_value () const
 Returns the entire vector as a const Eigen::VectorBlock. More...
 
Eigen::VectorBlock< VectorX< T > > get_mutable_value ()
 Returns the entire vector as a mutable Eigen::VectorBlock, which allows mutation of the values, but does not allow resizing the vector itself. More...
 
const T & GetAtIndex (int index) const override
 Returns the element at the given index in the vector. More...
 
T & GetAtIndex (int index) override
 Returns the element at the given index in the vector. More...
 
void SetFromVector (const Eigen::Ref< const VectorX< T >> &value) override
 Replaces the entire vector with the contents of value. More...
 
VectorX< T > CopyToVector () const override
 Copies the entire state to a vector with no semantics. More...
 
void ScaleAndAddToVector (const T &scale, Eigen::Ref< VectorX< T >> vec) const override
 Adds a scaled version of this vector to Eigen vector vec, which must be the same size. More...
 
void SetZero () override
 
NormInf () const override
 Computes the infinity norm for this vector. More...
 
std::unique_ptr< BasicVector< T > > Clone () const
 Copies the entire vector to a new BasicVector, with the same concrete implementation type. More...
 
 BasicVector (const BasicVector &)=delete
 
BasicVectoroperator= (const BasicVector &)=delete
 
 BasicVector (BasicVector &&)=delete
 
BasicVectoroperator= (BasicVector &&)=delete
 
- Public Member Functions inherited from VectorBase< T >
virtual ~VectorBase ()
 
T & operator[] (std::size_t idx)
 
const T & operator[] (std::size_t idx) const
 
void SetAtIndex (int index, const T &value)
 Replaces the state at the given index with the value. More...
 
virtual void SetFrom (const VectorBase< T > &value)
 Replaces the entire vector with the contents of value. More...
 
VectorBasePlusEqScaled (const T &scale, const VectorBase< T > &rhs)
 Add in scaled vector rhs to this vector. More...
 
VectorBasePlusEqScaled (const std::initializer_list< std::pair< T, const VectorBase< T > & >> &rhs_scale)
 Add in multiple scaled vectors to this vector. More...
 
VectorBaseoperator+= (const VectorBase< T > &rhs)
 Add in vector rhs to this vector. More...
 
VectorBaseoperator-= (const VectorBase< T > &rhs)
 Subtract in vector rhs to this vector. More...
 
virtual void CalcInequalityConstraint (VectorX< T > *value) const
 Populates a vector value suitable for a SystemConstraint inequality constraint. More...
 
 VectorBase (const VectorBase &)=delete
 
VectorBaseoperator= (const VectorBase &)=delete
 
 VectorBase (VectorBase &&)=delete
 
VectorBaseoperator= (VectorBase &&)=delete
 

Static Public Member Functions

static const std::vector< std::string > & GetCoordinateNames ()
 See MaliputRailcarParamsIndices::GetCoordinateNames(). More...
 
- Static Public Member Functions inherited from BasicVector< T >
static std::unique_ptr< BasicVector< T > > Make (const std::initializer_list< T > &data)
 Constructs a BasicVector whose elements are the elements of data. More...
 
template<typename... Fargs>
static std::unique_ptr< BasicVector< T > > Make (Fargs &&...args)
 Constructs a BasicVector where each element is constructed using the placewise-corresponding member of args as the sole constructor argument. More...
 

Additional Inherited Members

- Protected Member Functions inherited from VectorBase< T >
 VectorBase ()
 
- Static Protected Member Functions inherited from BasicVector< T >
template<typename F , typename... Fargs>
static void MakeRecursive (BasicVector< T > *data, int index, F constructor_arg, Fargs &&...recursive_args)
 Sets data at index to an object of type T, which must have a single-argument constructor invoked via constructor_arg, and then recursively invokes itself on the next index with recursive args. More...
 
template<typename F , typename... Fargs>
static void MakeRecursive (BasicVector< T > *data, int index, F constructor_arg)
 Base case for the MakeRecursive template recursion. More...
 

Detailed Description

template<typename T>
class drake::automotive::MaliputRailcarParams< T >

Specializes BasicVector with specific getters and setters.

Member Typedef Documentation

An abbreviation for our row index constants.

Constructor & Destructor Documentation

Default constructor.

Sets all rows to their default value:

  • r defaults to 0.0 m.
  • h defaults to 0.0 m.
  • max_speed defaults to 45.0 m/s.
  • velocity_limit_kp defaults to 10.0 Hz.

Member Function Documentation

MaliputRailcarParams<T>* DoClone ( ) const
inlineoverridevirtual

Returns a new BasicVector containing a copy of the entire vector.

Caller must take ownership, and may rely on the NVI wrapper to initialize the clone elementwise.

Subclasses of BasicVector must override DoClone to return their covariant type.

Reimplemented from BasicVector< T >.

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

See MaliputRailcarParamsIndices::GetCoordinateNames().

Here is the call graph for this function:

const T& h ( ) const
inline

The vehicle's height above the lane's surface.

Note
h is expressed in units of m.

Here is the caller graph for this function:

decltype(T() < T()) IsValid ( ) const
inline

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

Here is the call graph for this function:

const T& max_speed ( ) const
inline

The limit on the vehicle's forward speed, in meters per second; this element must be positive.

Note
max_speed is expressed in units of m/s.

Here is the caller graph for this function:

const T& r ( ) const
inline

The vehicle's position on the lane's r-axis.

Note
r is expressed in units of m.

Here is the caller graph for this function:

void set_h ( const T &  h)
inline
void set_max_speed ( const T &  max_speed)
inline
void set_r ( const T &  r)
inline
void set_velocity_limit_kp ( const T &  velocity_limit_kp)
inline
const T& velocity_limit_kp ( ) const
inline

The smoothing constant for min/max velocity limits; this element must be positive.

Note
velocity_limit_kp is expressed in units of Hz.

Here is the caller graph for this function:


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