base::Multivar

base::Multivar< T > Class Template Reference

A variable with multiple values of the same type. More...

#include <base_types2.hh>

List of all members.

Public Member Functions

 Multivar (void)
 ~Multivar ()
void Clear (void)
void Remove (T value)
void Set (T value)
void Add (T value)
void Toggle (T value)
bool Query (T value) const
bool IfEmpty (void) const

Private Attributes

std::list< T > mValues

Detailed Description

template<typename T = int>
class base::Multivar< T >

A variable with multiple values of the same type.

Remarks:
Tested by base/tests/src/multivar.cc

Constructor & Destructor Documentation

template<typename T = int>
base::Multivar< T >::Multivar ( void   )  [inline]

ctor/dtor

template<typename T = int>
base::Multivar< T >::~Multivar (  )  [inline]

Member Function Documentation

template<typename T = int>
void base::Multivar< T >::Clear ( void   )  [inline]

Clear all values.

template<typename T = int>
void base::Multivar< T >::Remove ( T  value  )  [inline]

Remove value.

template<typename T = int>
void base::Multivar< T >::Set ( T  value  )  [inline]

Replace all values with this value (replacement).

template<typename T = int>
void base::Multivar< T >::Add ( T  value  )  [inline]

Add an additional value (additive).

template<typename T = int>
void base::Multivar< T >::Toggle ( T  value  )  [inline]

Add or remove value.

template<typename T = int>
bool base::Multivar< T >::Query ( T  value  )  const [inline]

Returns:
True if multivar has this value.

template<typename T = int>
bool base::Multivar< T >::IfEmpty ( void   )  const [inline]

Returns:
True if multivar is empty.

Member Data Documentation

template<typename T = int>
std::list<T> base::Multivar< T >::mValues [private]

The documentation for this class was generated from the following file: Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:20 2007