apollo::data::TriggerBase Class Reference

Base class of triggers that defines interfaces. More...

#include <trigger_base.h>

Inheritance diagram for apollo::data::TriggerBase:

Collaboration diagram for apollo::data::TriggerBase:

Public Member Functions
	TriggerBase ()=default
virtual bool	Init (const SmartRecordTrigger &trigger_conf)
virtual void	Pull (const cyber::record::RecordMessage &msg)=0
virtual bool	ShouldRestore (const cyber::record::RecordMessage &msg) const =0
const std::string &	GetTriggerName () const
uint64_t	SecondsToNanoSeconds (const double seconds) const
virtual	~TriggerBase ()=default

Protected Member Functions
void	TriggerIt (const uint64_t msg_time) const
uint64_t	GetValidValueInRange (const double desired_value, const double min_limit, const double max_limit) const

Protected Attributes
std::string	trigger_name_
std::unique_ptr< Trigger >	trigger_obj_ = nullptr

Detailed Description

Base class of triggers that defines interfaces.

Constructor & Destructor Documentation

TriggerBase()

apollo::data::TriggerBase::TriggerBase ( )

default

~TriggerBase()

virtual apollo::data::TriggerBase::~TriggerBase ( )

virtualdefault

Member Function Documentation

GetTriggerName()

const std::string& apollo::data::TriggerBase::GetTriggerName ( ) const

inline

GetValidValueInRange()

uint64_t apollo::data::TriggerBase::GetValidValueInRange ( const double  desired_value, const double  min_limit, const double  max_limit  ) const

protected

Init()

virtual bool apollo::data::TriggerBase::Init ( const SmartRecordTrigger &  trigger_conf )

virtual

Pull()

virtual void apollo::data::TriggerBase::Pull ( const cyber::record::RecordMessage &  msg )

pure virtual

Implemented in apollo::data::HardBrakeTrigger, apollo::data::SwerveTrigger, apollo::data::SmallTopicsTrigger, apollo::data::EmergencyModeTrigger, apollo::data::DriveEventTrigger, and apollo::data::RegularIntervalTrigger.

SecondsToNanoSeconds()

uint64_t apollo::data::TriggerBase::SecondsToNanoSeconds

(

const double

seconds

)

const

ShouldRestore()

virtual bool apollo::data::TriggerBase::ShouldRestore ( const cyber::record::RecordMessage &  msg ) const

pure virtual

Implemented in apollo::data::HardBrakeTrigger, apollo::data::SwerveTrigger, apollo::data::SmallTopicsTrigger, apollo::data::EmergencyModeTrigger, apollo::data::DriveEventTrigger, and apollo::data::RegularIntervalTrigger.

TriggerIt()

void apollo::data::TriggerBase::TriggerIt ( const uint64_t  msg_time ) const

protected

Member Data Documentation

trigger_name_

std::string apollo::data::TriggerBase::trigger_name_

protected

trigger_obj_

std::unique_ptr<Trigger> apollo::data::TriggerBase::trigger_obj_ = nullptr

protected

---

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

• modules/data/tools/smart_recorder/trigger_base.h