List of all members | Public Member Functions | Protected Attributes | Friends
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. More...
 
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. More...
 
bool isRunning (const Ice::Current &=Ice::emptyCurrent) const override
 Returns whether the task is currently planning. More...
 
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. More...
 
Ice::Long refiningTime = 0
 The refining time in microseconds. More...
 
- Protected Attributes inherited from MotionPlanningTaskCI
AMDCallbackCollection waitForFinishedPlanning
 
AMDCallbackCollection waitForFinishedRunning
 

Friends

class MotionPlanningServer
 

Detailed Description

Definition at line 56 of file MotionPlanningTask.h.

Constructor & Destructor Documentation

◆ MotionPlanningTask()

MotionPlanningTask ( )
default

◆ ~MotionPlanningTask()

~MotionPlanningTask ( )
overridedefault

Member Function Documentation

◆ addTaskStatusCallback()

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

Definition at line 104 of file MotionPlanningTask.h.

◆ getPlanningTime()

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

Definition at line 109 of file MotionPlanningTask.h.

◆ getProxy()

MotionPlanningTaskBasePrx& getProxy ( )
inline

Definition at line 78 of file MotionPlanningTask.h.

+ Here is the caller graph for this function:

◆ getRefiningTime()

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

Definition at line 113 of file MotionPlanningTask.h.

◆ getRunningTime()

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

Definition at line 117 of file MotionPlanningTask.h.

◆ getTaskName()

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

Definition at line 99 of file MotionPlanningTask.h.

◆ getTaskStatus()

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

Definition at line 85 of file MotionPlanningTask.h.

+ Here is the caller graph for this function:

◆ onPlanningDone()

virtual void onPlanningDone ( )
inlinevirtual

Definition at line 75 of file MotionPlanningTask.h.

◆ onRefiningDone()

virtual void onRefiningDone ( )
inlinevirtual

Definition at line 76 of file MotionPlanningTask.h.

◆ 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.

Definition at line 70 of file MotionPlanningTask.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ registerAtIceAdapter()

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

Reimplemented in PostprocessingMotionPlanningTask.

Definition at line 90 of file MotionPlanningTask.h.

+ Here is the caller graph for this function:

◆ setTaskStatus()

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

Definition at line 30 of file MotionPlanningTask.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ MotionPlanningServer

friend class MotionPlanningServer
friend

Definition at line 60 of file MotionPlanningTask.h.

Member Data Documentation

◆ planningTime

Ice::Long planningTime = 0
protected

The planning time in microseconds.

Definition at line 126 of file MotionPlanningTask.h.

◆ refiningTime

Ice::Long refiningTime = 0
protected

The refining time in microseconds.

Definition at line 130 of file MotionPlanningTask.h.

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