Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
planning_scene_monitor::LockedPlanningSceneRO 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::LockedPlanningSceneRO:
Inheritance graph


struct  SingleUnlock

Public Member Functions

const PlanningSceneMonitorPtr & getPlanningSceneMonitor ()
 LockedPlanningSceneRO (const PlanningSceneMonitorPtr &planning_scene_monitor)
 operator bool () const
 operator const planning_scene::PlanningSceneConstPtr & () const
const planning_scene::PlanningSceneConstPtr & operator-> () const

Protected Member Functions

void initialize (bool read_only)
 LockedPlanningSceneRO (const PlanningSceneMonitorPtr &planning_scene_monitor, bool read_only)

Protected Attributes

SingleUnlockPtr lock_
PlanningSceneMonitorPtr planning_scene_monitor_

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:

moveit::core::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 PlanningSceneConstPtr, this works.

Any number of these "ReadOnly" locks can exist at a given time. The intention is that users which only need to read from the PlanningScene will use these and will thus not interfere with each other.

See also

Definition at line 643 of file planning_scene_monitor.h.

Constructor & Destructor Documentation

◆ LockedPlanningSceneRO() [1/2]

planning_scene_monitor::LockedPlanningSceneRO::LockedPlanningSceneRO ( const PlanningSceneMonitorPtr &  planning_scene_monitor)

Definition at line 646 of file planning_scene_monitor.h.

◆ LockedPlanningSceneRO() [2/2]

planning_scene_monitor::LockedPlanningSceneRO::LockedPlanningSceneRO ( const PlanningSceneMonitorPtr &  planning_scene_monitor,
bool  read_only 

Definition at line 673 of file planning_scene_monitor.h.

Member Function Documentation

◆ getPlanningSceneMonitor()

const PlanningSceneMonitorPtr& planning_scene_monitor::LockedPlanningSceneRO::getPlanningSceneMonitor ( )

Definition at line 652 of file planning_scene_monitor.h.

◆ initialize()

void planning_scene_monitor::LockedPlanningSceneRO::initialize ( bool  read_only)

Definition at line 679 of file planning_scene_monitor.h.


planning_scene_monitor::LockedPlanningSceneRO::MOVEIT_STRUCT_FORWARD ( SingleUnlock  )

◆ operator bool()

planning_scene_monitor::LockedPlanningSceneRO::operator bool ( ) const

Definition at line 657 of file planning_scene_monitor.h.

◆ operator const planning_scene::PlanningSceneConstPtr &()

planning_scene_monitor::LockedPlanningSceneRO::operator const planning_scene::PlanningSceneConstPtr & ( ) const

Definition at line 662 of file planning_scene_monitor.h.

◆ operator->()

const planning_scene::PlanningSceneConstPtr& planning_scene_monitor::LockedPlanningSceneRO::operator-> ( ) const

Definition at line 667 of file planning_scene_monitor.h.

Member Data Documentation

◆ lock_

SingleUnlockPtr planning_scene_monitor::LockedPlanningSceneRO::lock_

Definition at line 711 of file planning_scene_monitor.h.

◆ planning_scene_monitor_

PlanningSceneMonitorPtr planning_scene_monitor::LockedPlanningSceneRO::planning_scene_monitor_

Definition at line 710 of file planning_scene_monitor.h.

The documentation for this class was generated from the following file:
Definition: current_state_monitor.h:47
This is a convenience class for obtaining access to an instance of a locked PlanningScene.
Definition: planning_scene_monitor.h:643

Author(s): Ioan Sucan , Sachin Chitta
autogenerated on Wed Jul 21 2021 02:24:09