Plan::Engine::RunTimeStatistics Class Reference

Detailed Description

Class for handling run time statistics.

Public Member Functions
	RunTimeStatistics (IMC::PlanStatistics *msg)
void	clear (void)
void	fill (const FuelPrediction &fpred)
void	fillCalib (float time)
void	planStarted (void)
void	planStopped (void)
void	maneuverStarted (const std::string &id)
void	maneuverStopped (void)
Public Member Functions inherited from Plan::Engine::Statistics
	Statistics (IMC::PlanStatistics *msg)
void	setProperties (unsigned prop)

Additional Inherited Members
Protected Member Functions inherited from Plan::Engine::Statistics
void	addTuple (std::string &str, const std::string &name, float value, unsigned precision=1)
void	addTuple (std::string &str, const std::string &name, const std::string &value)
Protected Attributes inherited from Plan::Engine::Statistics
IMC::PlanStatistics *	m_ps

Constructor & Destructor Documentation

Plan::Engine::RunTimeStatistics::RunTimeStatistics ( IMC::PlanStatistics *  msg )

inline

Constructor.

Parameters

[in]

msg

pointer to statistics message

References Plan::Engine::Statistics::m_ps.

Member Function Documentation

void Plan::Engine::RunTimeStatistics::clear ( void  )

inline

Clear the message.

References Plan::Engine::Statistics::m_ps.

Referenced by Plan::Engine::Plan::planStarted().

void Plan::Engine::RunTimeStatistics::fill ( const FuelPrediction &  fpred )

inline

Fill in with fuel info.

Parameters

[in]

fpred

fuel prediction object

References Plan::Engine::Statistics::addTuple(), Plan::Engine::FuelPrediction::getPredictionError(), Plan::Engine::FuelPrediction::isFuelValid(), and Plan::Engine::Statistics::m_ps.

Referenced by Plan::Engine::Plan::planStopped().

void Plan::Engine::RunTimeStatistics::fillCalib ( float  time )

inline

Fill in calibration time.

Parameters

[in]

time

calibration total time

References Plan::Engine::Statistics::addTuple(), and Plan::Engine::Statistics::m_ps.

Referenced by Plan::Engine::Plan::updateCalibration().

void Plan::Engine::RunTimeStatistics::maneuverStarted ( const std::string &  id )

inline

Flag a maneuver as starting.

Parameters

[in]

id

name of the maneuver that is starting

Referenced by Plan::Engine::Plan::maneuverStarted().

void Plan::Engine::RunTimeStatistics::maneuverStopped ( void  )

inline

Flag a maneuver as stopped.

References Plan::Engine::Statistics::addTuple(), and Plan::Engine::Statistics::m_ps.

Referenced by Plan::Engine::Plan::maneuverDone().

void Plan::Engine::RunTimeStatistics::planStarted ( void  )

inline

Flag the plan as started.

Referenced by Plan::Engine::Plan::planStarted().

void Plan::Engine::RunTimeStatistics::planStopped ( void  )

inline

Flag the plan as stopped.

References Plan::Engine::Statistics::addTuple(), and Plan::Engine::Statistics::m_ps.

Referenced by Plan::Engine::Plan::planStopped().

Collaboration diagram for Plan::Engine::RunTimeStatistics: