ProximityProperties Class Reference

Detailed Description

The set of properties for geometry used in a proximity role.

Examples of functionality that depends on the proximity role:

#include <drake/geometry/geometry_roles.h>

Public Member Functions
	ProximityProperties ()=default
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	ProximityProperties (const ProximityProperties &)=default
ProximityProperties &	operator= (const ProximityProperties &)=default
	ProximityProperties (ProximityProperties &&)=default
ProximityProperties &	operator= (ProximityProperties &&)=default
Public Member Functions inherited from GeometryProperties
virtual	~GeometryProperties ()=default
bool	HasGroup (const std::string &group_name) const
	Reports if the given named group is part of this property set. More...
int	num_groups () const
	Reports the number of property groups in this set. More...
const Group &	GetPropertiesInGroup (const std::string &group_name) const
	Retrieves the indicated property group. More...
std::set< std::string >	GetGroupNames () const
	Returns all of the defined group names. More...
template<typename ValueType >
void	AddProperty (const std::string &group_name, const std::string &name, const ValueType &value)
	Adds the named property (group_name, name) with the given value. More...
template<typename ValueType >
void	UpdateProperty (const std::string &group_name, const std::string &name, const ValueType &value)
	Updates the named property (group_name, name) with the given value. More...
void	AddPropertyAbstract (const std::string &group_name, const std::string &name, const AbstractValue &value)
	Adds the named property (group_name, name) with the given type-erased value. More...
void	UpdatePropertyAbstract (const std::string &group_name, const std::string &name, const AbstractValue &value)
	Updates the named property (group_name, name) with the given type-erased value. More...
bool	HasProperty (const std::string &group_name, const std::string &name) const
	Reports if the property (group_name, name) exists in the group. More...
template<typename ValueType >
decltype(auto)	GetProperty (const std::string &group_name, const std::string &name) const
	Retrieves the typed value for the property (group_name, name) from this set of properties. More...
const AbstractValue &	GetPropertyAbstract (const std::string &group_name, const std::string &name) const
	Retrieves the type-erased value for the property (group_name, name) from this set of properties. More...
template<typename ValueType >
ValueType	GetPropertyOrDefault (const std::string &group_name, const std::string &name, ValueType default_value) const
	Retrieves the typed value for the property (group_name, name) from the set of properties (if it exists), otherwise returns the given default value. More...
bool	RemoveProperty (const std::string &group_name, const std::string &name)
	Removes the (group_name, name) property (if it exists). More...

Additional Inherited Members
Public Types inherited from GeometryProperties
using	Group = std::unordered_map< std::string, copyable_unique_ptr< AbstractValue > >
	The properties for a single group as a property name-value map. More...
Static Public Member Functions inherited from GeometryProperties
static const std::string &	default_group_name ()
	Returns the default group name. More...
Protected Member Functions inherited from GeometryProperties
	GeometryProperties ()
	Constructs a property set with the default group. More...
	GeometryProperties (const GeometryProperties &)=default
GeometryProperties &	operator= (const GeometryProperties &)=default
	GeometryProperties (GeometryProperties &&)=default
GeometryProperties &	operator= (GeometryProperties &&)=default

Constructor & Destructor Documentation

ProximityProperties() [1/3]

ProximityProperties ( const ProximityProperties &  )

default

ProximityProperties() [2/3]

ProximityProperties ( ProximityProperties &&  )

default

ProximityProperties() [3/3]

ProximityProperties ( )

default

Member Function Documentation

operator=() [1/2]

ProximityProperties& operator= ( const ProximityProperties &  )

default

operator=() [2/2]

ProximityProperties& operator= ( ProximityProperties &&  )

default

---

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

• drake/geometry/geometry_roles.h