Autoware.Auto
autoware::motion::planning::parking_planner::VehicleState< T > Class Template Reference

Class to represent the state of a vehicle. More...

#include <parking_planner_types.hpp>

Public Member Functions

 VehicleState () noexcept
 No-input constructor sets everything to the zero of the template parameter. More...
 
 VehicleState (T x, T y, T velocity, T heading, T steering) noexcept
 
std::vector< T > serialize (void) const
 Turn the object into flat vector of doubles (for use with numerical code) More...
 
get_x () const noexcept
 
get_y () const noexcept
 
get_velocity () const noexcept
 
get_heading () const noexcept
 
get_steering () const noexcept
 
void set_x (T x) noexcept
 
void set_y (T y) noexcept
 
void set_velocity (T velocity) noexcept
 
void set_heading (T heading) noexcept
 
void set_steering (T steering) noexcept
 
bool operator== (const VehicleState< T > &other) const noexcept
 Equality comparison operator. More...
 

Static Public Member Functions

static VehicleState deserialize (std::vector< T > serialized_states)
 
static constexpr std::size_t get_serialized_length () noexcept
 Get number of scalars a serialized version of this object has. More...
 

Detailed Description

template<typename T>
class autoware::motion::planning::parking_planner::VehicleState< T >

Class to represent the state of a vehicle.

Constructor & Destructor Documentation

◆ VehicleState() [1/2]

template<typename T >
autoware::motion::planning::parking_planner::VehicleState< T >::VehicleState ( )
inlinenoexcept

No-input constructor sets everything to the zero of the template parameter.

◆ VehicleState() [2/2]

template<typename T >
autoware::motion::planning::parking_planner::VehicleState< T >::VehicleState ( x,
y,
velocity,
heading,
steering 
)
inlinenoexcept

Member Function Documentation

◆ deserialize()

template<typename T >
static VehicleState autoware::motion::planning::parking_planner::VehicleState< T >::deserialize ( std::vector< T >  serialized_states)
inlinestatic

◆ get_heading()

template<typename T >
T autoware::motion::planning::parking_planner::VehicleState< T >::get_heading ( ) const
inlinenoexcept

◆ get_serialized_length()

template<typename T >
static constexpr std::size_t autoware::motion::planning::parking_planner::VehicleState< T >::get_serialized_length ( )
inlinestaticconstexprnoexcept

Get number of scalars a serialized version of this object has.

◆ get_steering()

template<typename T >
T autoware::motion::planning::parking_planner::VehicleState< T >::get_steering ( ) const
inlinenoexcept

◆ get_velocity()

template<typename T >
T autoware::motion::planning::parking_planner::VehicleState< T >::get_velocity ( ) const
inlinenoexcept

◆ get_x()

template<typename T >
T autoware::motion::planning::parking_planner::VehicleState< T >::get_x ( ) const
inlinenoexcept

◆ get_y()

template<typename T >
T autoware::motion::planning::parking_planner::VehicleState< T >::get_y ( ) const
inlinenoexcept

◆ operator==()

template<typename T >
bool autoware::motion::planning::parking_planner::VehicleState< T >::operator== ( const VehicleState< T > &  other) const
inlinenoexcept

Equality comparison operator.

◆ serialize()

template<typename T >
std::vector<T> autoware::motion::planning::parking_planner::VehicleState< T >::serialize ( void  ) const
inline

Turn the object into flat vector of doubles (for use with numerical code)

◆ set_heading()

template<typename T >
void autoware::motion::planning::parking_planner::VehicleState< T >::set_heading ( heading)
inlinenoexcept

◆ set_steering()

template<typename T >
void autoware::motion::planning::parking_planner::VehicleState< T >::set_steering ( steering)
inlinenoexcept

◆ set_velocity()

template<typename T >
void autoware::motion::planning::parking_planner::VehicleState< T >::set_velocity ( velocity)
inlinenoexcept

◆ set_x()

template<typename T >
void autoware::motion::planning::parking_planner::VehicleState< T >::set_x ( x)
inlinenoexcept

◆ set_y()

template<typename T >
void autoware::motion::planning::parking_planner::VehicleState< T >::set_y ( y)
inlinenoexcept

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