List of all members | Public Member Functions | Protected Member Functions | Friends
CSpaceVisualizerTask Class Reference

The purpose of this task is solely to visualize a cspace, which can be inspected in the CSpaceVisualizer GUI plugin. More...

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

+ Inheritance diagram for CSpaceVisualizerTask:

Public Member Functions

void abortTask (const Ice::Current &=Ice::emptyCurrent) override
 Does not do anything for this task. More...
 
 CSpaceVisualizerTask (const SimoxCSpaceWith2DPoseBasePtr &cspace, const VectorXf &robotPlatform2DPose, const std::string &taskName="CSpaceVisualizerTask")
 
Path getPath (const Ice::Current &=Ice::emptyCurrent) const override
 
void ice_postUnmarshal () override
 
void run (const RemoteObjectNodePrxList &, const Ice::Current &=Ice::emptyCurrent) override
 Does not do anything for this task. More...
 
- Public Member Functions inherited from MotionPlanningTaskWithDefaultMembers
CSpaceBasePtr getCSpace (const Ice::Current &=Ice::emptyCurrent) const override
 
float getDcdStep (const Ice::Current &=Ice::emptyCurrent) const override
 
VectorXf getGoal (const Ice::Current &=Ice::emptyCurrent) const override
 
Ice::Long getMaximalPlanningTimeInSeconds (const Ice::Current &=Ice::emptyCurrent) const override
 
VectorXf getStart (const Ice::Current &=Ice::emptyCurrent) const override
 
 MotionPlanningTaskWithDefaultMembers (const VectorXf &startCfg, const VectorXf &goalCfg, const CSpaceBasePtr &cspace, Ice::Float dcdStep, Ice::Long maximalPlanningTimeInSeconds, const std::string &taskName)
 ctor More...
 
- 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
 

Protected Member Functions

 CSpaceVisualizerTask ()=default
 Ctor used by object factories. More...
 
- Protected Member Functions inherited from MotionPlanningTaskWithDefaultMembers
 MotionPlanningTaskWithDefaultMembers ()=default
 

Friends

template<class Base , class Derived >
class ::armarx::GenericFactory
 

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

The purpose of this task is solely to visualize a cspace, which can be inspected in the CSpaceVisualizer GUI plugin.

Definition at line 37 of file CSpaceVisualizerTask.h.

Constructor & Destructor Documentation

◆ CSpaceVisualizerTask() [1/2]

CSpaceVisualizerTask ( const SimoxCSpaceWith2DPoseBasePtr &  cspace,
const VectorXf &  robotPlatform2DPose,
const std::string &  taskName = "CSpaceVisualizerTask" 
)

Definition at line 32 of file CSpaceVisualizerTask.cpp.

◆ CSpaceVisualizerTask() [2/2]

CSpaceVisualizerTask ( )
protecteddefault

Ctor used by object factories.

Member Function Documentation

◆ abortTask()

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

Does not do anything for this task.

Definition at line 52 of file CSpaceVisualizerTask.h.

◆ getPath()

Path getPath ( const Ice::Current &  = Ice::emptyCurrent) const
override
Returns
Contains the robot pose from the constructor..

Definition at line 62 of file CSpaceVisualizerTask.cpp.

◆ ice_postUnmarshal()

void ice_postUnmarshal ( )
override

Definition at line 78 of file CSpaceVisualizerTask.cpp.

◆ run()

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

Does not do anything for this task.

Definition at line 71 of file CSpaceVisualizerTask.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ ::armarx::GenericFactory

friend class ::armarx::GenericFactory
friend

Definition at line 73 of file CSpaceVisualizerTask.h.

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