DUNE: Uniform Navigational Environment  2019.02.1
Plan::Engine::Timeline Class Reference

Detailed Description

Class to gather each maneuver's ETA.

Classes

struct  ETA
 

Public Types

typedef std::pair< const std::string, ETAETAPair
 
typedef std::map< std::string, ETAETAMap
 

Public Member Functions

 Timeline (void)
 
 ~Timeline (void)
 
void setPlanETA (float value)
 
float getPlanETA (void) const
 
void setManeuverETA (const std::string &id, float start_eta, float end_eta)
 
float getManeuverStartETA (const std::string &id) const
 
float getManeuverEndETA (const std::string &id) const
 
float getExecutionDuration (void) const
 

Member Typedef Documentation

typedef std::map<std::string, ETA> Plan::Engine::Timeline::ETAMap

Map of maneuver ids to their ETAs.

typedef std::pair<const std::string, ETA> Plan::Engine::Timeline::ETAPair

Pair of maneuver id to it's ETA.

Constructor & Destructor Documentation

Plan::Engine::Timeline::Timeline ( void  )
inline

Constructor.

Plan::Engine::Timeline::~Timeline ( void  )
inline

Destructor.

Member Function Documentation

float Plan::Engine::Timeline::getExecutionDuration ( void  ) const
inline

Get execution duration.

Returns
execution duration in seconds

Referenced by Plan::Engine::ActionSchedule::ActionSchedule(), and Plan::Engine::PreStatistics::fill().

float Plan::Engine::Timeline::getManeuverEndETA ( const std::string &  id) const
inline

Get maneuver's end ETA.

Parameters
[in]idmaneuver id
Returns
maneuver's ETA, returns -1.0 if cannot find maneuver

Referenced by Plan::Engine::ActionSchedule::ActionSchedule(), Plan::Engine::PreStatistics::fill(), and Plan::Engine::ActionSchedule::fillComponentActiveTime().

float Plan::Engine::Timeline::getManeuverStartETA ( const std::string &  id) const
inline

Get maneuver's start ETA.

Parameters
[in]idmaneuver id
Returns
maneuver's ETA, returns -1.0 if cannot find maneuver

Referenced by Plan::Engine::ActionSchedule::ActionSchedule(), Plan::Engine::PreStatistics::fill(), and Plan::Engine::ActionSchedule::fillComponentActiveTime().

float Plan::Engine::Timeline::getPlanETA ( void  ) const
inline
void Plan::Engine::Timeline::setManeuverETA ( const std::string &  id,
float  start_eta,
float  end_eta 
)
inline

Set maneuver's ETA.

Parameters
[in]idmaneuver id
[in]start_etaestimated time of arrival of the start of the maneuver
[in]end_etaestimated time of arrival of the end of the maneuver

References Plan::Engine::Timeline::ETA::end, and Plan::Engine::Timeline::ETA::start.

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

void Plan::Engine::Timeline::setPlanETA ( float  value)
inline

Set the complete plan end ETA.

Parameters
[in]valueplan's end ETA

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

Collaboration diagram for Plan::Engine::Timeline:
Collaboration graph