karto::Pair< U, V > Class Template Reference

#include <Pair.h>

List of all members.

Public Member Functions
U &	GetFirst ()
const U &	GetFirst () const
V &	GetSecond ()
const V &	GetSecond () const
kt_bool	operator== (const Pair &rPair)
	Pair ()
	Pair (const U &rFirst, const V &rSecond)
Private Attributes
U	m_First
V	m_Second

---

Detailed Description

template<typename U, typename V>
class karto::Pair< U, V >

Pair class Any class that is used with Pair MUST implement operator==.

Definition at line 36 of file Pair.h.

---

Constructor & Destructor Documentation

template<typename U , typename V >

karto::Pair< U, V >::Pair

(

)

[inline]

Empty pair

Definition at line 42 of file Pair.h.

template<typename U , typename V >

karto::Pair< U, V >::Pair	(	const U &	rFirst,
		const V &	rSecond
	)		[inline]

A pair of the given items

Parameters:

rFirst	first item
rSecond	second item

Definition at line 51 of file Pair.h.

---

Member Function Documentation

template<typename U , typename V >

U& karto::Pair< U, V >::GetFirst

(

)

[inline]

Gets the first item in this pair

Returns:

first item in this pair

Definition at line 61 of file Pair.h.

template<typename U , typename V >

const U& karto::Pair< U, V >::GetFirst

(

)

const [inline]

Gets the first item in this pair (const version)

Returns:

first item in this pair

Definition at line 70 of file Pair.h.

template<typename U , typename V >

V& karto::Pair< U, V >::GetSecond

(

)

[inline]

Gets the second item in this pair

Returns:

second item in this pair

Definition at line 79 of file Pair.h.

template<typename U , typename V >

const V& karto::Pair< U, V >::GetSecond

(

)

const [inline]

Gets the second item in this pair (const version)

Returns:

second item in this pair

Definition at line 88 of file Pair.h.

template<typename U , typename V >

kt_bool karto::Pair< U, V >::operator==

(

const Pair< U, V > &

rPair

)

[inline]

Equality operator

Definition at line 96 of file Pair.h.

---

Member Data Documentation

template<typename U , typename V >

U karto::Pair< U, V >::m_First [private]

Definition at line 102 of file Pair.h.

template<typename U , typename V >

V karto::Pair< U, V >::m_Second [private]

Definition at line 103 of file Pair.h.

---

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

• Pair.h