MotionPlanningTask Class Reference

#include <RobotComponents/components/MotionPlanning/Tasks/MotionPlanningTask.h>

Inheritance diagram for MotionPlanningTask:

Public Member Functions
void	addTaskStatusCallback (std::function< void(TaskStatus::Status)> cb)
Ice::Long	getPlanningTime (const Ice::Current &) const override
MotionPlanningTaskBasePrx &	getProxy ()
Ice::Long	getRefiningTime (const Ice::Current &) const override
Ice::Long	getRunningTime (const Ice::Current &) const override
std::string	getTaskName (const Ice::Current &=Ice::emptyCurrent) const override
TaskStatus::Status	getTaskStatus (const Ice::Current &=Ice::emptyCurrent) const override
	MotionPlanningTask ()=default
virtual void	onPlanningDone ()
virtual void	onRefiningDone ()
virtual void	postEnqueueing ()
	Called by the planning server after the task was enqueued.
virtual void	registerAtIceAdapter (Ice::ObjectAdapterPtr &adapter, const Ice::Identity ident)
bool	setTaskStatus (TaskStatus::Status newTaskStatus, const Ice::Current &=Ice::emptyCurrent) override
	~MotionPlanningTask () override=default
Public Member Functions inherited from MotionPlanningTaskCI
bool	finishedRunning (const Ice::Current &=Ice::emptyCurrent) const override
	Returns whether the task has finished planning.
bool	isRunning (const Ice::Current &=Ice::emptyCurrent) const override
	Returns whether the task is currently planning.
void	waitForFinishedPlanning_async (const AMD_MotionPlanningTaskControlInterface_waitForFinishedPlanningPtr &cb, const Ice::Current &=Ice::emptyCurrent) override
void	waitForFinishedRunning_async (const AMD_MotionPlanningTaskControlInterface_waitForFinishedRunningPtr &cb, const Ice::Current &=Ice::emptyCurrent) override

Protected Attributes
Ice::Long	planningTime = 0
	The planning time in microseconds.
Ice::Long	refiningTime = 0
	The refining time in microseconds.
Protected Attributes inherited from MotionPlanningTaskCI
AMDCallbackCollection	waitForFinishedPlanning
AMDCallbackCollection	waitForFinishedRunning

Friends
class	MotionPlanningServer

Constructor & Destructor Documentation

MotionPlanningTask()

MotionPlanningTask ( )

default

~MotionPlanningTask()

~MotionPlanningTask ( )

overridedefault

Member Function Documentation

addTaskStatusCallback()

void addTaskStatusCallback ( std::function< void(TaskStatus::Status)> cb )

inline

getPlanningTime()

Ice::Long getPlanningTime ( const Ice::Current & ) const

inlineoverride

getProxy()

MotionPlanningTaskBasePrx & getProxy ( )

inline

getRefiningTime()

Ice::Long getRefiningTime ( const Ice::Current & ) const

inlineoverride

getRunningTime()

Ice::Long getRunningTime ( const Ice::Current & ) const

inlineoverride

getTaskName()

std::string getTaskName ( const Ice::Current & = Ice::emptyCurrent ) const

inlineoverride

getTaskStatus()

TaskStatus::Status getTaskStatus ( const Ice::Current & = Ice::emptyCurrent ) const

inlineoverride

onPlanningDone()

virtual void onPlanningDone ( )

inlinevirtual

onRefiningDone()

virtual void onRefiningDone ( )

inlinevirtual

postEnqueueing()

virtual void postEnqueueing ( )

inlinevirtual

Called by the planning server after the task was enqueued.

Override this function to prepare some work (e.g. setting the status from eNew to eQueued)

Reimplemented in PostprocessingMotionPlanningTask, and Task.

registerAtIceAdapter()

virtual void registerAtIceAdapter ( Ice::ObjectAdapterPtr & adapter, const Ice::Identity ident )

inlinevirtual

Reimplemented in PostprocessingMotionPlanningTask.

setTaskStatus()

bool setTaskStatus ( TaskStatus::Status newTaskStatus, const Ice::Current & = Ice::emptyCurrent )

override

Friends And Related Symbol Documentation

MotionPlanningServer

friend class MotionPlanningServer

friend

Member Data Documentation

planningTime

Ice::Long planningTime = 0

protected

The planning time in microseconds.

refiningTime

Ice::Long refiningTime = 0

protected

The refining time in microseconds.

---

The documentation for this class was generated from the following files:

• RobotComponents/components/MotionPlanning/Tasks/MotionPlanningTask.h
• RobotComponents/components/MotionPlanning/Tasks/MotionPlanningTask.cpp