Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
collision_detection::World Class Reference

Maintain a representation of the environment. More...

#include <world.h>

Classes

class  Action
 Represents an action that occurred on an object in the world. Several bits may be set indicating several things happened to the object. If the DESTROY bit is set, other bits will not be set. More...
 
struct  Object
 A representation of an object. More...
 
class  Observer
 
class  ObserverHandle
 

Public Types

enum  ActionBits {
  UNINITIALIZED = 0, CREATE = 1, DESTROY = 2, MOVE_SHAPE = 4,
  ADD_SHAPE = 8, REMOVE_SHAPE = 16
}
 
using const_iterator = std::map< std::string, ObjectPtr >::const_iterator
 
using ObserverCallbackFn = boost::function< void(const ObjectConstPtr &, Action)>
 

Public Member Functions

ObserverHandle addObserver (const ObserverCallbackFn &callback)
 register a callback function for notification of changes. callback will be called right after any change occurs to any Object. observer is the object which is requesting the changes. It is only used for identifying the callback in removeObserver(). More...
 
void addToObject (const std::string &object_id, const shapes::ShapeConstPtr &shape, const Eigen::Isometry3d &pose)
 Add a shape to an object. If the object already exists, this call will add the shape to the object at the specified pose. Otherwise, the object is created and the specified shape is added. This calls addToObjectInternal(). More...
 
void addToObject (const std::string &object_id, const std::vector< shapes::ShapeConstPtr > &shapes, const EigenSTL::vector_Isometry3d &poses)
 Add shapes to an object in the map. This function makes repeated calls to addToObjectInternal() to add the shapes one by one. More...
 
const_iterator begin () const
 
void clearObjects ()
 Clear all objects. If there are no other pointers to corresponding instances of Objects, the memory is freed. More...
 
const_iterator end () const
 
const_iterator find (const std::string &id) const
 
ObjectConstPtr getObject (const std::string &object_id) const
 Get a particular object. More...
 
std::vector< std::stringgetObjectIds () const
 Get the list of Object ids. More...
 
const Eigen::Isometry3d & getTransform (const std::string &name) const
 Get the transform to an object or subframe with given name. If name does not exist, a std::runtime_error is thrown. A subframe name needs to be prefixed with the object's name separated by a slash. The returned transform is guaranteed to be a valid isometry. More...
 
const Eigen::Isometry3d & getTransform (const std::string &name, bool &frame_found) const
 Get the transform to an object or subframe with given name. If name does not exist, returns an identity transform and sets frame_found to false. A subframe name needs to be prefixed with the object's name separated by a slash. The returned transform is guaranteed to be a valid isometry. More...
 
bool hasObject (const std::string &object_id) const
 Check if a particular object exists in the collision world. More...
 
bool knowsTransform (const std::string &name) const
 Check if an object or subframe with given name exists in the collision world. A subframe name needs to be prefixed with the object's name separated by a slash. More...
 
 MOVEIT_STRUCT_FORWARD (Object)
 
bool moveObject (const std::string &object_id, const Eigen::Isometry3d &transform)
 Move all shapes in an object according to the given transform specified in world frame. More...
 
bool moveShapeInObject (const std::string &object_id, const shapes::ShapeConstPtr &shape, const Eigen::Isometry3d &pose)
 Update the pose of a shape in an object. Shape equality is verified by comparing pointers. Returns true on success. More...
 
void notifyObserverAllObjects (const ObserverHandle observer_handle, Action action) const
 
bool removeObject (const std::string &object_id)
 Remove a particular object. If there are no external pointers to the corresponding instance of Object, the memory is freed. Returns true on success and false if no such object was found. More...
 
void removeObserver (const ObserverHandle observer_handle)
 remove a notifier callback More...
 
bool removeShapeFromObject (const std::string &object_id, const shapes::ShapeConstPtr &shape)
 Remove shape from object. Shape equality is verified by comparing pointers. Ownership of the object is renounced (i.e. object is deleted if no external references exist) if this was the last shape in the object. Returns true on success and false if the object did not exist or did not contain the shape. More...
 
bool setSubframesOfObject (const std::string &object_id, const moveit::core::FixedTransformsMap &subframe_poses)
 Set subframes on an object. More...
 
std::size_t size () const
 
 World ()
 Constructor. More...
 
 World (const World &other)
 A copy constructor. other should not be changed while the copy constructor is running This does copy on write and should be quick. More...
 
virtual ~World ()
 

Private Member Functions

virtual void addToObjectInternal (const ObjectPtr &obj, const shapes::ShapeConstPtr &shape, const Eigen::Isometry3d &pose)
 
void ensureUnique (ObjectPtr &obj)
 Make sure that the object named id is known only to this instance of the World. If the object is known outside of it, a clone is made so that it can be safely modified later on. More...
 
void notify (const ObjectConstPtr &, Action)
 
void notifyAll (Action action)
 

Private Attributes

std::map< std::string, ObjectPtr > objects_
 
std::vector< Observer * > observers_
 All registered observers of this world representation. More...
 

Detailed Description

Maintain a representation of the environment.

Definition at line 59 of file world.h.

Member Typedef Documentation

◆ const_iterator

iterator over the objects in the world.

Definition at line 122 of file world.h.

◆ ObserverCallbackFn

using collision_detection::World::ObserverCallbackFn = boost::function<void(const ObjectConstPtr&, Action)>

Definition at line 257 of file world.h.

Member Enumeration Documentation

◆ ActionBits

Enumerator
UNINITIALIZED 
CREATE 
DESTROY 

object was created

MOVE_SHAPE 

object was destroyed

ADD_SHAPE 

one or more shapes in object were moved

REMOVE_SHAPE 

shape(s) were added to object

Definition at line 207 of file world.h.

Constructor & Destructor Documentation

◆ World() [1/2]

collision_detection::World::World ( )

Constructor.

Definition at line 76 of file world.cpp.

◆ World() [2/2]

collision_detection::World::World ( const World other)

A copy constructor. other should not be changed while the copy constructor is running This does copy on write and should be quick.

Definition at line 80 of file world.cpp.

◆ ~World()

collision_detection::World::~World ( )
virtual

Definition at line 85 of file world.cpp.

Member Function Documentation

◆ addObserver()

World::ObserverHandle collision_detection::World::addObserver ( const ObserverCallbackFn callback)

register a callback function for notification of changes. callback will be called right after any change occurs to any Object. observer is the object which is requesting the changes. It is only used for identifying the callback in removeObserver().

Definition at line 333 of file world.cpp.

◆ addToObject() [1/2]

void collision_detection::World::addToObject ( const std::string object_id,
const shapes::ShapeConstPtr shape,
const Eigen::Isometry3d &  pose 
)

Add a shape to an object. If the object already exists, this call will add the shape to the object at the specified pose. Otherwise, the object is created and the specified shape is added. This calls addToObjectInternal().

Definition at line 129 of file world.cpp.

◆ addToObject() [2/2]

void collision_detection::World::addToObject ( const std::string object_id,
const std::vector< shapes::ShapeConstPtr > &  shapes,
const EigenSTL::vector_Isometry3d &  poses 
)

Add shapes to an object in the map. This function makes repeated calls to addToObjectInternal() to add the shapes one by one.

Note
This function does NOT call the addToObject() variant that takes a single shape and a single pose as input.

Definition at line 99 of file world.cpp.

◆ addToObjectInternal()

void collision_detection::World::addToObjectInternal ( const ObjectPtr &  obj,
const shapes::ShapeConstPtr shape,
const Eigen::Isometry3d &  pose 
)
inlineprivatevirtual

Definition at line 91 of file world.cpp.

◆ begin()

const_iterator collision_detection::World::begin ( ) const
inline

iterator pointing to first change

Definition at line 124 of file world.h.

◆ clearObjects()

void collision_detection::World::clearObjects ( )

Clear all objects. If there are no other pointers to corresponding instances of Objects, the memory is freed.

Definition at line 312 of file world.cpp.

◆ end()

const_iterator collision_detection::World::end ( ) const
inline

iterator pointing to end of changes

Definition at line 129 of file world.h.

◆ ensureUnique()

void collision_detection::World::ensureUnique ( ObjectPtr &  obj)
private

Make sure that the object named id is known only to this instance of the World. If the object is known outside of it, a clone is made so that it can be safely modified later on.

Definition at line 163 of file world.cpp.

◆ find()

const_iterator collision_detection::World::find ( const std::string id) const
inline

find changes for a named object

Definition at line 139 of file world.h.

◆ getObject()

World::ObjectConstPtr collision_detection::World::getObject ( const std::string object_id) const

Get a particular object.

Definition at line 154 of file world.cpp.

◆ getObjectIds()

std::vector< std::string > collision_detection::World::getObjectIds ( ) const

Get the list of Object ids.

Definition at line 146 of file world.cpp.

◆ getTransform() [1/2]

const Eigen::Isometry3d & collision_detection::World::getTransform ( const std::string name) const

Get the transform to an object or subframe with given name. If name does not exist, a std::runtime_error is thrown. A subframe name needs to be prefixed with the object's name separated by a slash. The returned transform is guaranteed to be a valid isometry.

Definition at line 194 of file world.cpp.

◆ getTransform() [2/2]

const Eigen::Isometry3d & collision_detection::World::getTransform ( const std::string name,
bool &  frame_found 
) const

Get the transform to an object or subframe with given name. If name does not exist, returns an identity transform and sets frame_found to false. A subframe name needs to be prefixed with the object's name separated by a slash. The returned transform is guaranteed to be a valid isometry.

Definition at line 203 of file world.cpp.

◆ hasObject()

bool collision_detection::World::hasObject ( const std::string object_id) const

Check if a particular object exists in the collision world.

Definition at line 169 of file world.cpp.

◆ knowsTransform()

bool collision_detection::World::knowsTransform ( const std::string name) const

Check if an object or subframe with given name exists in the collision world. A subframe name needs to be prefixed with the object's name separated by a slash.

Definition at line 174 of file world.cpp.

◆ MOVEIT_STRUCT_FORWARD()

collision_detection::World::MOVEIT_STRUCT_FORWARD ( Object  )

◆ moveObject()

bool collision_detection::World::moveObject ( const std::string object_id,
const Eigen::Isometry3d &  transform 
)

Move all shapes in an object according to the given transform specified in world frame.

Definition at line 255 of file world.cpp.

◆ moveShapeInObject()

bool collision_detection::World::moveShapeInObject ( const std::string object_id,
const shapes::ShapeConstPtr shape,
const Eigen::Isometry3d &  pose 
)

Update the pose of a shape in an object. Shape equality is verified by comparing pointers. Returns true on success.

Definition at line 234 of file world.cpp.

◆ notify()

void collision_detection::World::notify ( const ObjectConstPtr &  obj,
Action  action 
)
private

notify all observers of a change

Definition at line 359 of file world.cpp.

◆ notifyAll()

void collision_detection::World::notifyAll ( Action  action)
private

send notification of change to all objects.

Definition at line 353 of file world.cpp.

◆ notifyObserverAllObjects()

void collision_detection::World::notifyObserverAllObjects ( const ObserverHandle  observer_handle,
Action  action 
) const

send notification of change to all objects to a particular observer. Used which switching from one world to another.

Definition at line 365 of file world.cpp.

◆ removeObject()

bool collision_detection::World::removeObject ( const std::string object_id)

Remove a particular object. If there are no external pointers to the corresponding instance of Object, the memory is freed. Returns true on success and false if no such object was found.

Definition at line 300 of file world.cpp.

◆ removeObserver()

void collision_detection::World::removeObserver ( const ObserverHandle  observer_handle)

remove a notifier callback

Definition at line 340 of file world.cpp.

◆ removeShapeFromObject()

bool collision_detection::World::removeShapeFromObject ( const std::string object_id,
const shapes::ShapeConstPtr shape 
)

Remove shape from object. Shape equality is verified by comparing pointers. Ownership of the object is renounced (i.e. object is deleted if no external references exist) if this was the last shape in the object. Returns true on success and false if the object did not exist or did not contain the shape.

Definition at line 272 of file world.cpp.

◆ setSubframesOfObject()

bool collision_detection::World::setSubframesOfObject ( const std::string object_id,
const moveit::core::FixedTransformsMap subframe_poses 
)

Set subframes on an object.

Definition at line 318 of file world.cpp.

◆ size()

std::size_t collision_detection::World::size ( ) const
inline

number of changes stored

Definition at line 134 of file world.h.

Member Data Documentation

◆ objects_

std::map<std::string, ObjectPtr> collision_detection::World::objects_
private

The objects maintained in the world

Definition at line 289 of file world.h.

◆ observers_

std::vector<Observer*> collision_detection::World::observers_
private

All registered observers of this world representation.

Definition at line 302 of file world.h.


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


moveit_core
Author(s): Ioan Sucan , Sachin Chitta , Acorn Pooley
autogenerated on Sat Dec 12 2020 03:25:45