pcl::KeyValue< T1, T2 > Class Template Reference

Generic key-value association. More...

#include <KeyValue.h>

Public Member Functions
	KeyValue ()
	KeyValue (const KeyValue &)=default
	KeyValue (const T1 &k)
	KeyValue (const T1 &k, const T2 &v)
	KeyValue (KeyValue &&)=default
bool	operator< (const KeyValue &x) const
KeyValue &	operator= (const KeyValue &)=default
KeyValue &	operator= (KeyValue &&)=default
bool	operator== (const KeyValue &x) const

Public Attributes
T1	key
	The key member of this key-value association.
T2	value
	The value member of this key-value association.

Detailed Description

template<typename T1, typename T2>
class pcl::KeyValue< T1, T2 >

Definition at line 71 of file KeyValue.h.

Constructor & Destructor Documentation

KeyValue() [1/5]

template<typename T1 , typename T2 >

pcl::KeyValue< T1, T2 >::KeyValue ( )

inline

Constructs a key-value association with default key and value members.

Definition at line 81 of file KeyValue.h.

KeyValue() [2/5]

template<typename T1 , typename T2 >

pcl::KeyValue< T1, T2 >::KeyValue ( const T1 &  k, const T2 &  v  )

inline

Constructs a key-value association with the specified key and value.

Definition at line 90 of file KeyValue.h.

KeyValue() [3/5]

template<typename T1 , typename T2 >

pcl::KeyValue< T1, T2 >::KeyValue ( const T1 &  k )

inline

Constructs a key-value association with the specified key and a default-constructed value.

Definition at line 100 of file KeyValue.h.

KeyValue() [4/5]

template<typename T1 , typename T2 >

pcl::KeyValue< T1, T2 >::KeyValue ( const KeyValue< T1, T2 > &  )

default

Copy constructor.

KeyValue() [5/5]

template<typename T1 , typename T2 >

pcl::KeyValue< T1, T2 >::KeyValue ( KeyValue< T1, T2 > &&  )

default

Move constructor.

Member Function Documentation

operator<()

template<typename T1 , typename T2 >

bool pcl::KeyValue< T1, T2 >::operator< ( const KeyValue< T1, T2 > &  x ) const

inline

Returns true iff this key-value association precedes another object x. In key-value comparisons, key members have precedence over value members. The comparison algorithm is as follows:

if ( this->key != x.key )
   return this->key < x.key;
else
   return this->value < x.value;

The implementation of this operator only requires less than semantics for the two types T1 and T2; it doesn't use equality operators.

Definition at line 151 of file KeyValue.h.

References pcl::KeyValue< T1, T2 >::key, and pcl::KeyValue< T1, T2 >::value.

operator=() [1/2]

template<typename T1 , typename T2 >

KeyValue& pcl::KeyValue< T1, T2 >::operator= ( const KeyValue< T1, T2 > &  )

default

Copy assignment operator. Returns a reference to this object.

operator=() [2/2]

template<typename T1 , typename T2 >

KeyValue& pcl::KeyValue< T1, T2 >::operator= ( KeyValue< T1, T2 > &&  )

default

Move assignment operator. Returns a reference to this object.

operator==()

template<typename T1 , typename T2 >

bool pcl::KeyValue< T1, T2 >::operator== ( const KeyValue< T1, T2 > &  x ) const

inline

Returns true iff this key-value association is equal to another object x. key-value associations are equal if their respective key and value members are equal.

Definition at line 131 of file KeyValue.h.

References pcl::KeyValue< T1, T2 >::key, and pcl::KeyValue< T1, T2 >::value.

---

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

• KeyValue.h