collision_detection::OccMapTree Class Reference

#include <occupancy_map.h>

Inheritance diagram for collision_detection::OccMapTree:

Collaboration diagram for collision_detection::OccMapTree:

Public Types
using	ReadLock = std::shared_lock< std::shared_mutex >
using	WriteLock = std::unique_lock< std::shared_mutex >

Public Member Functions
	OccMapTree (double resolution)
	OccMapTree (const std::string &filename)
void	lockRead ()
	lock the underlying octree. it will not be read or written by the monitor until unlockTree() is called More...
void	unlockRead ()
	unlock the underlying octree. More...
void	lockWrite ()
	lock the underlying octree. it will not be read or written by the monitor until unlockTree() is called More...
void	unlockWrite ()
	unlock the underlying octree. More...
ReadLock	reading ()
WriteLock	writing ()
void	triggerUpdateCallback ()
void	setUpdateCallback (const std::function< void()> &update_callback)
	Set the callback to trigger when updates are received. More...

Detailed Description

Definition at line 51 of file occupancy_map.h.

Member Typedef Documentation

ReadLock

using collision_detection::OccMapTree::ReadLock = std::shared_lock<std::shared_mutex>

Definition at line 88 of file occupancy_map.h.

WriteLock

using collision_detection::OccMapTree::WriteLock = std::unique_lock<std::shared_mutex>

Definition at line 89 of file occupancy_map.h.

Constructor & Destructor Documentation

OccMapTree() [1/2]

collision_detection::OccMapTree::OccMapTree ( double  resolution )

inline

Definition at line 54 of file occupancy_map.h.

OccMapTree() [2/2]

collision_detection::OccMapTree::OccMapTree ( const std::string &  filename )

inline

Definition at line 58 of file occupancy_map.h.

Member Function Documentation

lockRead()

void collision_detection::OccMapTree::lockRead ( )

inline

lock the underlying octree. it will not be read or written by the monitor until unlockTree() is called

Definition at line 64 of file occupancy_map.h.

lockWrite()

void collision_detection::OccMapTree::lockWrite ( )

inline

lock the underlying octree. it will not be read or written by the monitor until unlockTree() is called

Definition at line 77 of file occupancy_map.h.

reading()

ReadLock collision_detection::OccMapTree::reading ( )

inline

Definition at line 91 of file occupancy_map.h.

setUpdateCallback()

void collision_detection::OccMapTree::setUpdateCallback ( const std::function< void()> &  update_callback )

inline

Set the callback to trigger when updates are received.

Definition at line 108 of file occupancy_map.h.

triggerUpdateCallback()

void collision_detection::OccMapTree::triggerUpdateCallback ( )

inline

Definition at line 101 of file occupancy_map.h.

unlockRead()

void collision_detection::OccMapTree::unlockRead ( )

inline

unlock the underlying octree.

Definition at line 70 of file occupancy_map.h.

unlockWrite()

void collision_detection::OccMapTree::unlockWrite ( )

inline

unlock the underlying octree.

Definition at line 83 of file occupancy_map.h.

writing()

WriteLock collision_detection::OccMapTree::writing ( )

inline

Definition at line 96 of file occupancy_map.h.

---

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

• moveit_core/collision_detection/include/moveit/collision_detection/occupancy_map.h