Skip to content

Commit 31c3f1c

Browse files
committed
Clarify robot idle-state definition
Signed-off-by: kjchee <keai_jiang_chee@cgh.com.sg>
1 parent d30a92b commit 31c3f1c

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

rmf_task/include/rmf_task/State.hpp

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,11 @@ class State : public CompositeData
105105
/// CurrentOrientation, or CurrentTime) then this will return a std::nullopt.
106106
std::optional<rmf_traffic::agv::Plan::Start> extract_plan_start() const;
107107

108-
/// Check if the robot is idle, i.e. it is not assigned to any task and is
109-
/// not currently executing any task.
108+
/// Check if the robot is idle.
109+
///
110+
/// True if the robot is not executing any task.
111+
/// False only when the robot is actively executing a task
112+
/// (finishing requests are not counted as execution).
110113
RMF_TASK_DEFINE_COMPONENT(bool, IsIdle);
111114
bool is_idle() const;
112115
State& idle(bool is_idle);

0 commit comments

Comments
 (0)