Class RobotUpdateHandle::ActionExecution
Defined in File RobotUpdateHandle.hpp
Nested Relationships
This class is a nested type of Class RobotUpdateHandle.
Class Documentation
-
class ActionExecution
The ActionExecution class should be used to manage the execution of and provide updates on ongoing actions.
Public Functions
-
void update_remaining_time(rmf_traffic::Duration remaining_time_estimate)
Update the amount of time remaining for this action.
-
void underway(std::optional<std::string> text)
Set task status to underway and optionally log a message (info tier)
-
void error(std::optional<std::string> text)
Set task status to error and optionally log a message (error tier)
-
void delayed(std::optional<std::string> text)
Set the task status to delayed and optionally log a message (warning tier)
-
void blocked(std::optional<std::string> text)
Set the task status to blocked and optionally log a message (warning tier)
-
void finished()
Trigger this when the action is successfully finished.
-
bool okay() const
Returns false if the Action has been killed or cancelled.
-
void update_remaining_time(rmf_traffic::Duration remaining_time_estimate)