apollo::cyber::TimerComponent Class Reference

TimerComponent is a timer component. Your component can inherit from Component, and implement Init() & Proc(), They are called by the CyberRT frame. More...

#include <timer_component.h>

Inheritance diagram for apollo::cyber::TimerComponent:

Collaboration diagram for apollo::cyber::TimerComponent:

Public Member Functions
	TimerComponent ()
	~TimerComponent () override
bool	Initialize (const TimerComponentConfig &config) override
	init the component by protobuf object. More...
void	Clear () override
bool	Process ()
uint64_t	GetInterval () const
Public Member Functions inherited from apollo::cyber::ComponentBase
virtual	~ComponentBase ()
virtual bool	Initialize (const ComponentConfig &config)
virtual void	Shutdown ()
template<typename T >
bool	GetProtoConfig (T *config) const

Additional Inherited Members
Public Types inherited from apollo::cyber::ComponentBase
template<typename M >
using	Reader = cyber::Reader< M >
Protected Member Functions inherited from apollo::cyber::ComponentBase
virtual bool	Init ()=0
const std::string &	ConfigFilePath () const
void	LoadConfigFiles (const ComponentConfig &config)
void	LoadConfigFiles (const TimerComponentConfig &config)
Protected Attributes inherited from apollo::cyber::ComponentBase
std::atomic< bool >	is_shutdown_ = {false}
std::shared_ptr< Node >	node_ = nullptr
std::string	config_file_path_ = ""
std::vector< std::shared_ptr< ReaderBase > >	readers_

Detailed Description

TimerComponent is a timer component. Your component can inherit from Component, and implement Init() & Proc(), They are called by the CyberRT frame.

Constructor & Destructor Documentation

TimerComponent()

apollo::cyber::TimerComponent::TimerComponent

(

)

~TimerComponent()

apollo::cyber::TimerComponent::~TimerComponent ( )

override

Member Function Documentation

Clear()

void apollo::cyber::TimerComponent::Clear ( )

overridevirtual

Reimplemented from apollo::cyber::ComponentBase.

GetInterval()

uint64_t apollo::cyber::TimerComponent::GetInterval

(

)

const

Initialize()

bool apollo::cyber::TimerComponent::Initialize ( const TimerComponentConfig &  config )

overridevirtual

init the component by protobuf object.

Parameters

config

which is define in 'cyber/proto/component_conf.proto'

Returns

returns true if successful, otherwise returns false

Reimplemented from apollo::cyber::ComponentBase.

Process()

bool apollo::cyber::TimerComponent::Process

(

)

---

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

• cyber/component/timer_component.h