List of all members | Public Member Functions
Task Class Reference

#include <RobotComponents/components/MotionPlanning/Tasks/PathCollection/Task.h>

+ Inheritance diagram for Task:

Public Member Functions

void abortTask (const Ice::Current &=Ice::emptyCurrent) override
 
void addPath (Path p)
 
void addPath (PathWithCost p)
 
PathWithCostSeq getAllPathsWithCost (const Ice::Current &=Ice::emptyCurrent) const override
 
PathWithCost getBestPath (const Ice::Current &=Ice::emptyCurrent) const override
 
CSpaceBasePtr getCSpace (const Ice::Current &=Ice::emptyCurrent) const override
 
Ice::Long getMaximalPlanningTimeInSeconds (const Ice::Current &=Ice::emptyCurrent) const override
 
Path getNthPath (Ice::Long n, const Ice::Current &=Ice::emptyCurrent) const override
 
PathWithCost getNthPathWithCost (Ice::Long n, const Ice::Current &=Ice::emptyCurrent) const override
 
Path getPath (const Ice::Current &=Ice::emptyCurrent) const override
 
Ice::Long getPathCount (const Ice::Current &=Ice::emptyCurrent) const override
 
PathWithCost getPathWithCost (const Ice::Current &=Ice::emptyCurrent) const override
 
void run (const RemoteObjectNodePrxList &, const Ice::Current &=Ice::emptyCurrent) override
 Runs the task. More...
 
 Task (const std::string &taskName="PathCollection")
 
 ~Task () override=default
 
- Public Member Functions inherited from MotionPlanningTask
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
 
- Public Member Functions inherited from MotionPlanningMultiPathWithCostTaskCI
PathSeq getAllPaths (const Ice::Current &=Ice::emptyCurrent) const override
 
Path getNthPath (Ice::Long n, const Ice::Current &=Ice::emptyCurrent) const override
 
Path getPath (const Ice::Current &=Ice::emptyCurrent) const override
 
- Public Member Functions inherited from MotionPlanningMultiPathTaskCI
Path getPath (const Ice::Current &=Ice::emptyCurrent) const override
 
- Public Member Functions inherited from MotionPlanningWithCostTaskCI
Path getPath (const Ice::Current &=Ice::emptyCurrent) const override
 

Additional Inherited Members

- Protected Attributes inherited from MotionPlanningTask
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
 

Detailed Description

Definition at line 43 of file Task.h.

Constructor & Destructor Documentation

◆ Task()

Task ( const std::string &  taskName = "PathCollection")
inline

Definition at line 49 of file Task.h.

◆ ~Task()

~Task ( )
overridedefault

Member Function Documentation

◆ abortTask()

void abortTask ( const Ice::Current &  = Ice::emptyCurrent)
inlineoverride

Definition at line 75 of file Task.h.

◆ addPath() [1/2]

void addPath ( Path  p)
inline

Definition at line 126 of file Task.h.

+ Here is the call graph for this function:

◆ addPath() [2/2]

void addPath ( PathWithCost  p)
inline

Definition at line 138 of file Task.h.

◆ getAllPathsWithCost()

PathWithCostSeq getAllPathsWithCost ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 120 of file Task.h.

◆ getBestPath()

PathWithCost getBestPath ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 104 of file Task.h.

+ Here is the call graph for this function:

◆ getCSpace()

CSpaceBasePtr getCSpace ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 80 of file Task.h.

◆ getMaximalPlanningTimeInSeconds()

Ice::Long getMaximalPlanningTimeInSeconds ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 92 of file Task.h.

◆ getNthPath()

Path getNthPath ( Ice::Long  n,
const Ice::Current &  = Ice::emptyCurrent 
) const
inlineoverride

Definition at line 63 of file Task.h.

+ Here is the call graph for this function:

◆ getNthPathWithCost()

PathWithCost getNthPathWithCost ( Ice::Long  n,
const Ice::Current &  = Ice::emptyCurrent 
) const
inlineoverride

Definition at line 110 of file Task.h.

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

◆ getPath()

Path getPath ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 69 of file Task.h.

+ Here is the call graph for this function:

◆ getPathCount()

Ice::Long getPathCount ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 98 of file Task.h.

◆ getPathWithCost()

PathWithCost getPathWithCost ( const Ice::Current &  = Ice::emptyCurrent) const
inlineoverridevirtual

Reimplemented from MotionPlanningMultiPathWithCostTaskCI.

Definition at line 57 of file Task.h.

+ Here is the call graph for this function:

◆ run()

void run ( const RemoteObjectNodePrxList &  ,
const Ice::Current &  = Ice::emptyCurrent 
)
override

Runs the task.

Parameters
remoteNodesThe list of RemoteObjectNodeInterfacePrx used to distribute work to computers.

Definition at line 30 of file Task.cpp.

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: