CrystalSpace

Public API Reference

csTuple2< First, Second > Class Template Reference
[Containers]

A two length tuple (fixed size collection of elements) Tuples are typically used for quickly bounding grouped values around with a low overhead. More...

#include <csutil/tuple.h>

List of all members.

Public Types

typedef First FirstType
 typedef that can be accessed to recreate object of the first type
typedef Second SecondType
 typedef that can be accessed to recreate object of the second type

Public Member Functions

template<typename AlFirst , typename AlSecond >
 csTuple2 (const csTuple2< AlFirst, AlSecond > &t)
 Templated constructor from another csTuple2.
 csTuple2 (const First &first, const Second &second)
 Constructor to initialise both elements.
 csTuple2 ()
 Empty default constructor.

Public Attributes

First first
 First element in Tuple.
Second second
 Second element in Tuple.

Detailed Description

template<typename First, typename Second>
class csTuple2< First, Second >

A two length tuple (fixed size collection of elements) Tuples are typically used for quickly bounding grouped values around with a low overhead.

Definition at line 35 of file tuple.h.


Member Typedef Documentation

template<typename First, typename Second>
typedef First csTuple2< First, Second >::FirstType

typedef that can be accessed to recreate object of the first type

Definition at line 40 of file tuple.h.

template<typename First, typename Second>
typedef Second csTuple2< First, Second >::SecondType

typedef that can be accessed to recreate object of the second type

Definition at line 43 of file tuple.h.


Constructor & Destructor Documentation

template<typename First, typename Second>
csTuple2< First, Second >::csTuple2 (  )  [inline]

Empty default constructor.

Definition at line 51 of file tuple.h.

template<typename First, typename Second>
csTuple2< First, Second >::csTuple2 ( const First &  first,
const Second &  second 
) [inline]

Constructor to initialise both elements.

Definition at line 53 of file tuple.h.

template<typename First, typename Second>
template<typename AlFirst , typename AlSecond >
csTuple2< First, Second >::csTuple2 ( const csTuple2< AlFirst, AlSecond > &  t  )  [inline]

Templated constructor from another csTuple2.

Definition at line 57 of file tuple.h.


Member Data Documentation

template<typename First, typename Second>
First csTuple2< First, Second >::first

First element in Tuple.

Definition at line 46 of file tuple.h.

template<typename First, typename Second>
Second csTuple2< First, Second >::second

Second element in Tuple.

Definition at line 48 of file tuple.h.


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

Generated for Crystal Space 2.0 by doxygen 1.6.1