VehicleModel Class Reference

Vehicle model interface. More...

#include <vehicle_model.hpp>

Inheritance diagram for VehicleModel:

Collaboration diagram for VehicleModel:

Public Member Functions
virtual	~VehicleModel ()=default
virtual void	step (double dt)=0
virtual void	reset ()=0
virtual double	get_position_x () const =0
virtual double	get_position_y () const =0
virtual double	get_yaw () const =0
virtual double	get_velocity_x () const =0
virtual void	set_position (double x, double y, double yaw)=0
virtual void	set_velocity (double vx)=0
virtual void	set_steering (double angle)=0
virtual void	set_throttle (double throttle)=0
virtual std::string	get_model_name () const =0

Detailed Description

Vehicle model interface.

Defines a simplified interface that all vehicle models must implement. Certainly will be extended during the vehicle model implementation.

Definition at line 12 of file vehicle_model.hpp.

Constructor & Destructor Documentation

~VehicleModel()

virtual VehicleModel::~VehicleModel ( )

virtualdefault

Member Function Documentation

get_model_name()

virtual std::string VehicleModel::get_model_name ( ) const

pure virtual

Implemented in BicycleModel.

get_position_x()

virtual double VehicleModel::get_position_x ( ) const

pure virtual

Implemented in BicycleModel.

get_position_y()

virtual double VehicleModel::get_position_y ( ) const

pure virtual

Implemented in BicycleModel.

get_velocity_x()

virtual double VehicleModel::get_velocity_x ( ) const

pure virtual

Implemented in BicycleModel.

get_yaw()

virtual double VehicleModel::get_yaw ( ) const

pure virtual

Implemented in BicycleModel.

reset()

virtual void VehicleModel::reset ( )

pure virtual

Implemented in BicycleModel.

set_position()

virtual void VehicleModel::set_position ( double  x, double  y, double  yaw  )

pure virtual

Implemented in BicycleModel.

set_steering()

virtual void VehicleModel::set_steering ( double  angle )

pure virtual

Implemented in BicycleModel.

set_throttle()

virtual void VehicleModel::set_throttle ( double  throttle )

pure virtual

Implemented in BicycleModel.

set_velocity()

virtual void VehicleModel::set_velocity ( double  vx )

pure virtual

Implemented in BicycleModel.

step()

virtual void VehicleModel::step ( double  dt )

pure virtual

Implemented in BicycleModel.

---

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

• src/invictasim/include/vehicle_model/vehicle_model.hpp