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, ETA >	ETAPair
typedef std::map< std::string, ETA >	ETAMap

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.

References Plan::Engine::Timeline::ETA::end.

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]

id

maneuver 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]

id

maneuver 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

Get the complete plan ETA.

Returns

the plan's ETA

References Plan::Engine::Timeline::ETA::start.

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

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

inline

Set maneuver's ETA.

Parameters

[in]	id	maneuver id
[in]	start_eta	estimated time of arrival of the start of the maneuver
[in]	end_eta	estimated time of arrival of the end of the maneuver

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

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

inline

Set the complete plan end ETA.

Parameters

[in]

value

plan's end ETA

References Plan::Engine::Timeline::ETA::start.

Collaboration diagram for Plan::Engine::Timeline: