apollo::dreamview::FuelMonitor Class Reference

A base class that monitor progress for Fuel client. More...

#include <fuel_monitor.h>

Inheritance diagram for apollo::dreamview::FuelMonitor:

Collaboration diagram for apollo::dreamview::FuelMonitor:

Public Member Functions
	FuelMonitor (const std::string &name)
	Constructor of FuelMonitor. More...
virtual	~FuelMonitor ()=default
bool	IsEnabled () const
virtual void	Start ()=0
	start monitoring More...
virtual void	Stop ()=0
	stop monitoring More...
std::string	GetClassName () const
	get class name More...
void	Restart ()
	restart monitoring More...
virtual nlohmann::json	GetProgressAsJson ()=0
	return current progress of as json More...

Protected Attributes
bool	enabled_ = false
std::string	class_name_

Detailed Description

A base class that monitor progress for Fuel client.

Constructor & Destructor Documentation

FuelMonitor()

apollo::dreamview::FuelMonitor::FuelMonitor ( const std::string &  name )

inlineexplicit

Constructor of FuelMonitor.

~FuelMonitor()

virtual apollo::dreamview::FuelMonitor::~FuelMonitor ( )

virtualdefault

Member Function Documentation

GetClassName()

std::string apollo::dreamview::FuelMonitor::GetClassName ( ) const

inline

get class name

GetProgressAsJson()

virtual nlohmann::json apollo::dreamview::FuelMonitor::GetProgressAsJson ( )

pure virtual

return current progress of as json

Implemented in apollo::dreamview::DataCollectionMonitor, and apollo::dreamview::PreprocessMonitor.

IsEnabled()

bool apollo::dreamview::FuelMonitor::IsEnabled ( ) const

inline

Restart()

void apollo::dreamview::FuelMonitor::Restart ( )

inline

restart monitoring

Start()

virtual void apollo::dreamview::FuelMonitor::Start ( )

pure virtual

start monitoring

Implemented in apollo::dreamview::DataCollectionMonitor, and apollo::dreamview::PreprocessMonitor.

Stop()

virtual void apollo::dreamview::FuelMonitor::Stop ( )

pure virtual

stop monitoring

Implemented in apollo::dreamview::DataCollectionMonitor, and apollo::dreamview::PreprocessMonitor.

Member Data Documentation

class_name_

std::string apollo::dreamview::FuelMonitor::class_name_

protected

enabled_

bool apollo::dreamview::FuelMonitor::enabled_ = false

protected

---

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

• modules/dreamview/backend/fuel_monitor/fuel_monitor.h