Home Previous Up Next Index

armarx::MotionPlanningTaskControlInterface

Overview

interface MotionPlanningTaskControlInterface

@brief The interface used by a client to control a server side task.

Derived Classes and Interfaces

MotionPlanningMultiPathTaskControlInterface
MotionPlanningTaskBase
MotionPlanningWithCostTaskControlInterface

Operation Index

abortTask
@brief Aborts the task.
getPath
@return The found path.
getTaskStatus
@return The task's status.
isRunning
@return Whether the task is currently running.
finishedRunning
@return Whether the task has finished running.
waitForFinishedPlanning
waitForFinishedRunning
getPlanningTime
@return The planning time in microseconds
getRefiningTime
@return The refining time in microseconds
getRunningTime
@return The running time in microseconds

Operations

void abortTask()

@brief Aborts the task. Frees all allocated processing Resources and deques the task. Causes a state transition.

See Also

TaskStatus::Status

Path getPath()

Return Value

The found path. If no path was found an empty Path is returned.

TaskStatus::Status getTaskStatus()

Return Value

The task's status.

bool isRunning()

Return Value

Whether the task is currently running.

bool finishedRunning()

Return Value

Whether the task has finished running.

void waitForFinishedPlanning()

void waitForFinishedRunning()

long getPlanningTime()

Return Value

The planning time in microseconds

long getRefiningTime()

Return Value

The refining time in microseconds

long getRunningTime()

Return Value

The running time in microseconds


Home Previous Up Next Index