$search

ecl::formatters::PushAndPopFormatter< Type, N > Class Template Reference

Pseudo formatter for integral type arrays. More...

#include <formatters.hpp>

List of all members.

Public Member Functions

ecl::PushAndPop< Type, N > & operator() (ecl::PushAndPop< Type, N > &container)
virtual ~PushAndPopFormatter ()

Detailed Description

template<typename Type, size_t N>
class ecl::formatters::PushAndPopFormatter< Type, N >

Pseudo formatter for integral type arrays.

These do nothing but pass the array back for streaming. Do not use this class directly, rather call it via either the Array or Format classes explicitly. This makes the code more readable. e.g.

 // fixed array
 PushAndPop<int, 5>::Formatter format_1;
 Format< PushAndPop<int,4> > format_2;    // same thing

 // dynamic array
 PushAndPop<int>::Formatter float_dynamic_formatter_1;
 Format< PushAndPop<int> > format_dynamic_formatter_2;
Template Parameters:
Type : the value type of the fixed size Array.
N : the size of the container to be formatted.
Todo:
Specialise the formatting for these integral type arrays so that they return formatting possibilities equivalent to their base type.

Definition at line 58 of file push_and_pop/formatters.hpp.


Constructor & Destructor Documentation

template<typename Type , size_t N>
virtual ecl::formatters::PushAndPopFormatter< Type, N >::~PushAndPopFormatter (  )  [inline, virtual]

Definition at line 30 of file push_and_pop/formatters.hpp.


Member Function Documentation

template<typename Type , size_t N>
ecl::PushAndPop<Type,N>& ecl::formatters::PushAndPopFormatter< Type, N >::operator() ( ecl::PushAndPop< Type, N > &  container  )  [inline]

Pseudo formatter method, simply returns the underlying array which has its own stream operator.

Parameters:
array : the array to be formatted.
Returns:
PushAndPop<Type,N> : just returns the input array.

Definition at line 38 of file push_and_pop/formatters.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Defines


ecl_containers
Author(s): Daniel Stonier (d.stonier@gmail.com)
autogenerated on Fri Mar 1 15:21:08 2013