Apollo  6.0
Open source self driving car software
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
apollo::control::Controller Class Referenceabstract

base class for all controllers. More...

#include <controller.h>

Inheritance diagram for apollo::control::Controller:
Inheritance graph
Collaboration diagram for apollo::control::Controller:
Collaboration graph

Public Member Functions

 Controller ()=default
 constructor More...
 
virtual ~Controller ()=default
 destructor More...
 
virtual common::Status Init (std::shared_ptr< DependencyInjector > injector, const ControlConf *control_conf)=0
 initialize Controller More...
 
virtual common::Status ComputeControlCommand (const localization::LocalizationEstimate *localization, const canbus::Chassis *chassis, const planning::ADCTrajectory *trajectory, control::ControlCommand *cmd)=0
 compute control command based on current vehicle status and target trajectory More...
 
virtual common::Status Reset ()=0
 reset Controller More...
 
virtual std::string Name () const =0
 controller name More...
 
virtual void Stop ()=0
 stop controller More...
 

Detailed Description

base class for all controllers.

Constructor & Destructor Documentation

◆ Controller()

apollo::control::Controller::Controller ( )
default

constructor

◆ ~Controller()

virtual apollo::control::Controller::~Controller ( )
virtualdefault

destructor

Member Function Documentation

◆ ComputeControlCommand()

virtual common::Status apollo::control::Controller::ComputeControlCommand ( const localization::LocalizationEstimate *  localization,
const canbus::Chassis *  chassis,
const planning::ADCTrajectory *  trajectory,
control::ControlCommand *  cmd 
)
pure virtual

compute control command based on current vehicle status and target trajectory

Parameters
localizationvehicle location
chassisvehicle status e.g., speed, acceleration
trajectorytrajectory generated by planning
cmdcontrol command
Returns
Status computation status

Implemented in apollo::control::LonController.

◆ Init()

virtual common::Status apollo::control::Controller::Init ( std::shared_ptr< DependencyInjector injector,
const ControlConf *  control_conf 
)
pure virtual

initialize Controller

Parameters
control_confcontrol configurations
Returns
Status initialization status

Implemented in apollo::control::LatController, apollo::control::MPCController, and apollo::control::LonController.

◆ Name()

virtual std::string apollo::control::Controller::Name ( ) const
pure virtual

controller name

Returns
string controller name in string

Implemented in apollo::control::LatController, apollo::control::MPCController, and apollo::control::LonController.

◆ Reset()

virtual common::Status apollo::control::Controller::Reset ( )
pure virtual

◆ Stop()

virtual void apollo::control::Controller::Stop ( )
pure virtual

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