FramePairMap< T > Class Template Reference

A map from an unordered pair of frames to some value. More...

#include <FramePairMap.hpp>

Inherits PairMap< const Frame *, T >.

Public Member Functions
	FramePairMap ()
	creates a map More...
	FramePairMap (const T &defaultVal)
	creates a map with an initial size of s More...
Public Member Functions inherited from PairMap< const Frame *, T >
	PairMap ()
	creates a map
	PairMap (const T &defaultVal)
	creates a map with an initial size of s More...
void	insert (const Pair &pair, const T &value)
	inserts a value into the map More...
bool	has (const Pair &pair) const
	True iff a value for frame has been inserted in the map (or accessed using non-const operator[]).
bool	has (const const Frame * f1, const const Frame * f2) const
	True iff a value for frame has been inserted in the map (or accessed using operator[]). More...
const T &	operator[] (const Pair &pair) const
	return a reference to the value that is associated with the pair pair. More...
T &	operator[] (const Pair &pair)
	return a reference to the value that is associated with the pair More...
const T &	operator() (const Frame * f1, const Frame * f2) const
	return a reference to the value that is associated with the pair consisting of f1 and f2. More...
T &	operator() (const Frame * f1, const Frame * f2)
	return a reference to the value that is associated with the pair consisting of f1 and f2. More...
void	erase (const Pair &pair)
	Erase a pair from the map. More...
void	erase (const Frame * f1, const Frame * f2)
void	clear ()
	Clear the map.
std::size_t	size () const
	Return the map size. More...
std::size_t	max_size () const
	Return maximum size. More...
bool	empty () const
	Test whether map is empty. More...

Detailed Description

template<class T>
class rw::kinematics::FramePairMap< T >

A map from an unordered pair of frames to some value.

Constructor & Destructor Documentation

FramePairMap() [1/2]

FramePairMap ( )

inline

creates a map

FramePairMap() [2/2]

FramePairMap ( const T &  defaultVal )

inline

creates a map with an initial size of s

Parameters

defaultVal

[in] the default value of new instances of T

---

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

• FramePairMap.hpp