Autoware.Auto
autoware::common::reference_tracking_controller::ReferenceTrackerBase< T > Class Template Referenceabstract

#include <reference_tracking_controller.hpp>

Classes

struct  SignalWithDerivative
 A Pack of both the signal and it's derivative at some time step. More...
 

Public Member Functions

virtual ~ReferenceTrackerBase ()=default
 Virtual destructor. More...
 
virtual T feedback (SignalWithDerivative reference, SignalWithDerivative observation)=0
 
feedback (T reference, SignalWithDerivative observation)
 
feedback (SignalWithDerivative reference, T observation)
 
feedback (T reference, T observation)
 

Detailed Description

template<typename T>
class autoware::common::reference_tracking_controller::ReferenceTrackerBase< T >

Interface class for 1D reference trackers

Template Parameters
TA floating point type

Constructor & Destructor Documentation

◆ ~ReferenceTrackerBase()

Virtual destructor.

Member Function Documentation

◆ feedback() [1/4]

template<typename T >
virtual T autoware::common::reference_tracking_controller::ReferenceTrackerBase< T >::feedback ( SignalWithDerivative  reference,
SignalWithDerivative  observation 
)
pure virtual

Primary API: given current reference and current observation (and derivatives), compute feedback control

Parameters
[in]referenceThe value being tracked, sometimes referred to as y
[in]observationThe current observed value of the tracked value, sometimes referred to as z or o
Returns
The feedback value

◆ feedback() [2/4]

template<typename T >
T autoware::common::reference_tracking_controller::ReferenceTrackerBase< T >::feedback ( SignalWithDerivative  reference,
observation 
)
inline

Primary API: given current reference and current observation (and derivatives), compute feedback control. Observation derivative is assumed to be zero

Parameters
[in]referenceThe value being tracked, sometimes referred to as y, with derivative
[in]observationThe current observed value of the tracked value, sometimes referred to as z or o
Returns
The feedback value

◆ feedback() [3/4]

template<typename T >
T autoware::common::reference_tracking_controller::ReferenceTrackerBase< T >::feedback ( reference,
SignalWithDerivative  observation 
)
inline

Primary API: given current reference and current observation (and derivatives), compute feedback control. Reference derivative is assumed to be 0

Parameters
[in]referenceThe value being tracked, sometimes referred to as y
[in]observationThe current observed value of the tracked value, sometimes referred to as z or o, with derivative
Returns
The feedback value

◆ feedback() [4/4]

template<typename T >
T autoware::common::reference_tracking_controller::ReferenceTrackerBase< T >::feedback ( reference,
observation 
)
inline

Primary API: given current reference and current observation, compute feedback control. All derivatives are assumed to be zero

Parameters
[in]referenceThe value being tracked, sometimes referred to as y
[in]observationThe current observed value of the tracked value, sometimes referred to as z or o
Returns
The feedback value

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