Elemental::ValueList< T > Class Template Reference

A qualified list of values of a generic type. More...

#include <value.hh>

Inheritance diagram for Elemental::ValueList< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

template<class S >
 ValueList (const S source[], int count, Qualifier qualifier=Q_NEUTRAL)
 Constructs a new defined value list.
template<class S >
 ValueList (const ValueList< S > &source)
 Constructs a new value list based on another value list.
 ValueList (Qualifier qualifier=Q_UNK) throw ()
 Constructs a new undefined or empty value list.
virtual int compare (const value_base &other) const throw ()

Public Attributes

std::vector< T > values
 The values, if defined.

Protected Member Functions

virtual ustring do_get_string (const ustring &format) const throw ()
 Returns a localized text representation of a defined value.

Detailed Description

template<class T>
class Elemental::ValueList< T >

A qualified list of values of a generic type.

This template requires a class with default and copy constructors and less-than, greater-than, and stream insertion operators. Compiler-generated functions are acceptable.


Constructor & Destructor Documentation

template<class T>
template<class S >
Elemental::ValueList< T >::ValueList ( const S  source[],
int  count,
Qualifier  qualifier = Q_NEUTRAL 
) [inline]

Constructs a new defined value list.

Parameters:
source An array of the initial values.
count The length of the source array.
qualifier The qualification of the initial values.
template<class T>
template<class S >
Elemental::ValueList< T >::ValueList ( const ValueList< S > &  source  )  [inline]

Constructs a new value list based on another value list.

Parameters:
source The value list to be copied.
template<class T>
Elemental::ValueList< T >::ValueList ( Qualifier  qualifier = Q_UNK  )  throw ()

Constructs a new undefined or empty value list.

Parameters:
qualifier The qualification of the initial values.

Member Function Documentation

template<class T>
virtual ustring Elemental::ValueList< T >::do_get_string ( const ustring &  format  )  const throw () [protected, virtual]

Returns a localized text representation of a defined value.

Derived classes must implement this function to produce a text representation based on the format. It will be called by get_string(), which will then decorate its output as appropriate for the current qualifier. If has_value() is false, the behavior is undefined.

Parameters:
format A compose-style format string. Derived classes may define the number of argument references expected in the string; the default is one. If format is empty, a minimal default should be used.
Returns:
A UTF-8 string containing the localized representation.

Implements Elemental::value_base.


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

Generated on Sun Oct 4 18:34:15 2009 for libelemental by  doxygen 1.6.1