Functions | |
| bool | finishedRunning (Status status) |
| Returns whether the given task status describes a state where planning is done (may be failed). More... | |
| bool | isRunning (Status status) |
| Returns whether the given task status describes a state where a path is planned. More... | |
| std::string | toString (Status status) |
| Returns the given task status as a string. More... | |
| Status | transitionAtDone (Status status) |
| Performs a transition from the given to the appropiate following status in case the task is done. More... | |
| Status | transitionAtKill (Status status) |
| Performs a transition from the given to the appropiate following status in case of a task kill. More... | |
| Status | transitionAtOutoftime (Status status) |
| Performs a transition from the given to the appropiate following status in case of the task failing. More... | |
Function Documentation
◆ finishedRunning()
| bool finishedRunning | ( | Status | status | ) |
Returns whether the given task status describes a state where planning is done (may be failed).
- Parameters
-
status The status to check.
- Returns
- Whether the given task status describes a state where planning is done (may be failed)
Definition at line 97 of file PlanningUtil.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ isRunning()
| bool isRunning | ( | Status | status | ) |
Returns whether the given task status describes a state where a path is planned.
- Parameters
-
status The status to check.
- Returns
- Whether the given task status describes a state where a path is planned.
Definition at line 69 of file PlanningUtil.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ toString()
| std::string toString | ( | Status | status | ) |
Returns the given task status as a string.
- Parameters
-
status The status to return as a string.
- Returns
- The given task status as a string.
Definition at line 31 of file PlanningUtil.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ transitionAtDone()
| Status transitionAtDone | ( | Status | status | ) |
Performs a transition from the given to the appropiate following status in case the task is done.
- Parameters
-
status The source status for the transition.
- Returns
- Returns the following status.
Definition at line 186 of file PlanningUtil.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ transitionAtKill()
| Status transitionAtKill | ( | Status | status | ) |
Performs a transition from the given to the appropiate following status in case of a task kill.
- Parameters
-
status The source status for the transition.
- Returns
- Returns the following status.
Definition at line 126 of file PlanningUtil.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ transitionAtOutoftime()
| Status transitionAtOutoftime | ( | Status | status | ) |
Performs a transition from the given to the appropiate following status in case of the task failing.
- Parameters
-
status The source status for the transition.
- Returns
- Returns the following status.
Definition at line 156 of file PlanningUtil.cpp.
Here is the call graph for this function: Here is the caller graph for this function: