Burger::Pair< T1, T2 > Class Template Reference

Template for creating an object pair. More...

Public Types
typedef T1	first_type
	Type of the first object in the pair.
typedef T2	second_type
	Type of the second object in the pair.

Public Member Functions
	Pair ()
	Default constructor.
	Pair (const T1 &rFirst, const T2 &rSecond)
	Construct with instances.
	Pair (const Pair< T1, T2 > &rInput)
	Copy constructor.
void	operator= (const Pair< T1, T2 > &rInput)

Public Attributes
T1	first
	First object in the pair.
T2	second
	Second object in the pair.

Detailed Description

template<class T1, class T2>
class Burger::Pair< T1, T2 >

Template for creating an object pair.

---

For cases where two objects need to be paired together, this template will easily perform that data pairing.

This is a functional equivalent to the STL template "pair".

See also

HashMap

Member Typedef Documentation

first_type

template<class T1, class T2>

typedef T1 Burger::Pair< T1, T2 >::first_type

Type of the first object in the pair.

---

See also

second_type

second_type

template<class T1, class T2>

typedef T2 Burger::Pair< T1, T2 >::second_type

Type of the second object in the pair.

---

See also

first_type

Constructor & Destructor Documentation

Pair() [1/3]

template<class T1, class T2>

Burger::Pair< T1, T2 >::Pair ( )

inline

Default constructor.

---

See also

Pair(const Pair<T1,T2> &) or Pair(const T1 &,const T2 &)

Pair() [2/3]

template<class T1, class T2>

Burger::Pair< T1, T2 >::Pair ( const T1 & rFirst, const T2 & rSecond )

inline

Construct with instances.

---

Parameters

rFirst	Reference to the first object to copy
rSecond	Reference to the second object to copy

See also

Pair() or Pair(const Pair<T1,T2> &)

Pair() [3/3]

template<class T1, class T2>

Burger::Pair< T1, T2 >::Pair ( const Pair< T1, T2 > & rInput )

inline

Copy constructor.

---

Parameters

rInput

Reference to the pair to copy

See also

Pair() or Pair(const T1 &,const T2 &)

Member Function Documentation

operator=()

template<class T1, class T2>

void Burger::Pair< T1, T2 >::operator= ( const Pair< T1, T2 > & rInput )

inline

Member Data Documentation

first

template<class T1, class T2>

T1 Burger::Pair< T1, T2 >::first

First object in the pair.

second

template<class T1, class T2>

T2 Burger::Pair< T1, T2 >::second

Second object in the pair.