armarx::TaskStatus Namespace Reference

Functions
bool	finishedRunning (Status status)
	Returns whether the given task status describes a state where planning is done (may be failed).
bool	isRunning (Status status)
	Returns whether the given task status describes a state where a path is planned.
std::string	toString (Status status)
	Returns the given task status as a string.
Status	transitionAtDone (Status status)
	Performs a transition from the given to the appropiate following status in case the task is done.
Status	transitionAtKill (Status status)
	Performs a transition from the given to the appropiate following status in case of a task kill.
Status	transitionAtOutoftime (Status status)
	Performs a transition from the given to the appropiate following status in case of the task failing.

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)

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.

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.

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.

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.

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.