Public Member Functions
planning_scene_monitor::LockedPlanningSceneRW Class Reference

This is a convenience class for obtaining access to an instance of a locked PlanningScene. More...

#include <planning_scene_monitor.h>

Inheritance diagram for planning_scene_monitor::LockedPlanningSceneRW:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 LockedPlanningSceneRW (const PlanningSceneMonitorPtr &planning_scene_monitor)
 operator const planning_scene::PlanningScenePtr & ()
const
planning_scene::PlanningScenePtr & 
operator-> ()

Detailed Description

This is a convenience class for obtaining access to an instance of a locked PlanningScene.

Instances of this class can be used almost exactly like instances of a PlanningScenePtr because of the typecast operator and "operator->" functions. Therefore you will often see code like this:

   planning_scene_monitor::LockedPlanningSceneRW ls(planning_scene_monitor);
   robot_model::RobotModelConstPtr model = ls->getRobotModel();

The function "getRobotModel()" is a member of PlanningScene and not a member of this class. However because of the "operator->" here which returns a PlanningScenePtr, this works.

Only one of these "ReadWrite" locks can exist at a given time. The intention is that users which need to write to the PlanningScene will use these, preventing other writers and readers from locking the same PlanningScene at the same time.

See also:
LockedPlanningSceneRO

Definition at line 666 of file planning_scene_monitor.h.


Constructor & Destructor Documentation

planning_scene_monitor::LockedPlanningSceneRW::LockedPlanningSceneRW ( const PlanningSceneMonitorPtr &  planning_scene_monitor) [inline]

Definition at line 669 of file planning_scene_monitor.h.


Member Function Documentation

planning_scene_monitor::LockedPlanningSceneRW::operator const planning_scene::PlanningScenePtr & ( ) [inline]

Definition at line 674 of file planning_scene_monitor.h.

const planning_scene::PlanningScenePtr& planning_scene_monitor::LockedPlanningSceneRW::operator-> ( ) [inline]

Definition at line 679 of file planning_scene_monitor.h.


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


planning
Author(s): Ioan Sucan , Sachin Chitta
autogenerated on Fri Apr 20 2018 03:31:39