collision_space::EnvironmentObjects Class Reference

List of objects contained in the environment (not including robot links) More...

#include <environment_objects.h>

List of all members.

Classes
struct	NamespaceObjects
Public Member Functions
void	addObject (const std::string &ns, shapes::StaticShape *shape)
	Add a static object to the namespace. The user releases ownership of the object.
void	addObject (const std::string &ns, shapes::Shape *shape, const tf::Transform &pose)
	Add an object to the namespace. The user releases ownership of the object.
void	addObjectNamespace (const std::string ns)
	Adds namespace without necessary adding a shape.
void	clearObjects (const std::string &ns)
	Clear the objects in a specific namespace. Memory is freed.
void	clearObjects (void)
	Clear all objects. Memory is freed.
EnvironmentObjects *	clone (void) const
	Clone this instance of the class.
	EnvironmentObjects (void)
std::vector< std::string >	getNamespaces (void) const
	Get the list of namespaces.
const NamespaceObjects &	getObjects (const std::string &ns) const
	Get the list of objects.
NamespaceObjects &	getObjects (const std::string &ns)
	Get the list of objects.
bool	removeObject (const std::string &ns, const shapes::Shape *shape)
	Remove object. Object equality is verified by comparing pointers. Ownership of the object is renounced upon. Returns true on success.
bool	removeObject (const std::string &ns, const shapes::StaticShape *shape)
	Remove object. Object equality is verified by comparing pointers. Ownership of the object is renounced upon. Returns true on success.
	~EnvironmentObjects (void)
Private Attributes
NamespaceObjects	empty_
std::map< std::string, NamespaceObjects >	objects_

---

Detailed Description

List of objects contained in the environment (not including robot links)

Definition at line 51 of file environment_objects.h.

---

Constructor & Destructor Documentation

collision_space::EnvironmentObjects::EnvironmentObjects

(

void

)

[inline]

Definition at line 54 of file environment_objects.h.

collision_space::EnvironmentObjects::~EnvironmentObjects

(

void

)

[inline]

Definition at line 58 of file environment_objects.h.

---

Member Function Documentation

void collision_space::EnvironmentObjects::addObject	(	const std::string &	ns,
		shapes::StaticShape *	shape
	)

Add a static object to the namespace. The user releases ownership of the object.

Definition at line 62 of file environment_objects.cpp.

void collision_space::EnvironmentObjects::addObject	(	const std::string &	ns,
		shapes::Shape *	shape,
		const tf::Transform &	pose
	)

Add an object to the namespace. The user releases ownership of the object.

Definition at line 67 of file environment_objects.cpp.

void collision_space::EnvironmentObjects::addObjectNamespace

(

const std::string

ns

)

Adds namespace without necessary adding a shape.

Definition at line 128 of file environment_objects.cpp.

void collision_space::EnvironmentObjects::clearObjects

(

const std::string &

ns

)

Clear the objects in a specific namespace. Memory is freed.

Definition at line 106 of file environment_objects.cpp.

void collision_space::EnvironmentObjects::clearObjects

(

void

)

Clear all objects. Memory is freed.

Definition at line 121 of file environment_objects.cpp.

collision_space::EnvironmentObjects * collision_space::EnvironmentObjects::clone

(

void

)

const

Clone this instance of the class.

Definition at line 136 of file environment_objects.cpp.

std::vector< std::string > collision_space::EnvironmentObjects::getNamespaces

(

void

)

const

Get the list of namespaces.

Author:

Ioan Sucan

Definition at line 40 of file environment_objects.cpp.

const collision_space::EnvironmentObjects::NamespaceObjects & collision_space::EnvironmentObjects::getObjects

(

const std::string &

ns

)

const

Get the list of objects.

Definition at line 48 of file environment_objects.cpp.

collision_space::EnvironmentObjects::NamespaceObjects & collision_space::EnvironmentObjects::getObjects

(

const std::string &

ns

)

Get the list of objects.

Definition at line 57 of file environment_objects.cpp.

bool collision_space::EnvironmentObjects::removeObject	(	const std::string &	ns,
		const shapes::Shape *	shape
	)

Remove object. Object equality is verified by comparing pointers. Ownership of the object is renounced upon. Returns true on success.

Definition at line 73 of file environment_objects.cpp.

bool collision_space::EnvironmentObjects::removeObject	(	const std::string &	ns,
		const shapes::StaticShape *	shape
	)

Remove object. Object equality is verified by comparing pointers. Ownership of the object is renounced upon. Returns true on success.

Definition at line 90 of file environment_objects.cpp.

---

Member Data Documentation

NamespaceObjects collision_space::EnvironmentObjects::empty_ [private]

Definition at line 111 of file environment_objects.h.

std::map<std::string, NamespaceObjects> collision_space::EnvironmentObjects::objects_ [private]

Definition at line 110 of file environment_objects.h.

---

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

• environment_objects.h
• environment_objects.cpp