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
	ProximityProperties (const GeometryProperties &other)
	~ProximityProperties () final
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 ()
bool	HasGroup (const std::string &group_name) const
	Reports if the given named group is part of this property set.
int	num_groups () const
	Reports the number of property groups in this set.
const Group &	GetPropertiesInGroup (const std::string &group_name) const
	Retrieves the indicated property group.
std::set< std::string >	GetGroupNames () const
	Returns all of the defined group names.
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.
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.
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.
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.
bool	HasProperty (const std::string &group_name, const std::string &name) const
	Reports if the property (group_name, name) exists in the group.
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.
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.
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.
bool	RemoveProperty (const std::string &group_name, const std::string &name)
	Removes the (group_name, name) property (if it exists).
std::string	to_string () const
	Converts the GeometryProperties to a string representation.

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

Constructor & Destructor Documentation

ProximityProperties() [1/4]

ProximityProperties ( const ProximityProperties & )

default

ProximityProperties() [2/4]

ProximityProperties ( ProximityProperties && )

default

ProximityProperties() [3/4]

ProximityProperties ( )

default

ProximityProperties() [4/4]

ProximityProperties ( const GeometryProperties & other )

explicit

~ProximityProperties()

~ProximityProperties ( )

final

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