moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Types | Public Member Functions | List of all members
collision_detection::WorldDiff Class Reference

Maintain a diff list of changes that have happened to a World. More...

#include <world_diff.h>

Public Types

using const_iterator = std::map< std::string, World::Action >::const_iterator
 

Public Member Functions

 WorldDiff ()
 Constructor. More...
 
 WorldDiff (const WorldPtr &world)
 Constructor. More...
 
 WorldDiff (WorldDiff &other)
 copy constructor. More...
 
 ~WorldDiff ()
 
void setWorld (const WorldPtr &world)
 Set which world to record. Records all objects in old world (if any) as DESTROYED and all objects in new world as CREATED and ADD_SHAPE. More...
 
void reset (const WorldPtr &world)
 Set which world to record. Erases all previously recorded changes.
More...
 
void reset ()
 Turn off recording and erase all previously recorded changes. More...
 
const std::map< std::string, World::Action > & getChanges () const
 Return all the changes that have been recorded. More...
 
const_iterator begin () const
 
const_iterator end () const
 
size_t size () const
 
const_iterator find (const std::string &id) const
 
void set (const std::string &id, World::Action val)
 
void clearChanges ()
 Clear the internally maintained vector of changes. More...
 

Detailed Description

Maintain a diff list of changes that have happened to a World.

Definition at line 47 of file world_diff.h.

Member Typedef Documentation

◆ const_iterator

Definition at line 79 of file world_diff.h.

Constructor & Destructor Documentation

◆ WorldDiff() [1/3]

collision_detection::WorldDiff::WorldDiff ( )

Constructor.

Definition at line 49 of file world_diff.cpp.

◆ WorldDiff() [2/3]

collision_detection::WorldDiff::WorldDiff ( const WorldPtr &  world)

Constructor.

Definition at line 53 of file world_diff.cpp.

◆ WorldDiff() [3/3]

collision_detection::WorldDiff::WorldDiff ( WorldDiff other)

copy constructor.

Definition at line 59 of file world_diff.cpp.

◆ ~WorldDiff()

collision_detection::WorldDiff::~WorldDiff ( )

Definition at line 42 of file world_diff.cpp.

Member Function Documentation

◆ begin()

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

iterator pointing to first change

Definition at line 81 of file world_diff.h.

◆ clearChanges()

void collision_detection::WorldDiff::clearChanges ( )

Clear the internally maintained vector of changes.

Definition at line 112 of file world_diff.cpp.

Here is the caller graph for this function:

◆ end()

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

iterator pointing to end of changes

Definition at line 86 of file world_diff.h.

Here is the caller graph for this function:

◆ find()

const_iterator collision_detection::WorldDiff::find ( const std::string &  id) const
inline

find changes for a named object

Definition at line 96 of file world_diff.h.

◆ getChanges()

const std::map<std::string, World::Action>& collision_detection::WorldDiff::getChanges ( ) const
inline

Return all the changes that have been recorded.

Definition at line 74 of file world_diff.h.

Here is the caller graph for this function:

◆ reset() [1/2]

void collision_detection::WorldDiff::reset ( )

Turn off recording and erase all previously recorded changes.

Definition at line 72 of file world_diff.cpp.

Here is the call graph for this function:

◆ reset() [2/2]

void collision_detection::WorldDiff::reset ( const WorldPtr &  world)

Set which world to record. Erases all previously recorded changes.

Definition at line 83 of file world_diff.cpp.

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

◆ set()

void collision_detection::WorldDiff::set ( const std::string &  id,
World::Action  val 
)
inline

set the entry for an id

Definition at line 101 of file world_diff.h.

◆ setWorld()

void collision_detection::WorldDiff::setWorld ( const WorldPtr &  world)

Set which world to record. Records all objects in old world (if any) as DESTROYED and all objects in new world as CREATED and ADD_SHAPE.

Definition at line 96 of file world_diff.cpp.

Here is the caller graph for this function:

◆ size()

size_t collision_detection::WorldDiff::size ( ) const
inline

number of changes stored

Definition at line 91 of file world_diff.h.


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