Public Member Functions
ecl::formatters::ArrayFormatter< Type, N > Class Template Reference

Pseudo formatter for integral type arrays. More...

#include <formatters.hpp>

List of all members.

Public Member Functions

ecl::Array< Type, N > & operator() (ecl::Array< Type, N > &array)
virtual ~ArrayFormatter ()

Detailed Description

template<typename Type, size_t N>
class ecl::formatters::ArrayFormatter< 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
 Array<int, 5>::Formatter format_array_1;
 Format< Array<int,4> > format_array_2;    // same thing

 // dynamic array
 Array<int>::Formatter float_array_dynamic_formatter_1;
 Format< Array<int> > format_array_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 64 of file array/formatters.hpp.


Constructor & Destructor Documentation

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

Definition at line 67 of file array/formatters.hpp.


Member Function Documentation

template<typename Type , size_t N>
ecl::Array<Type,N>& ecl::formatters::ArrayFormatter< Type, N >::operator() ( ecl::Array< Type, N > &  array) [inline]

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

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

Definition at line 75 of file array/formatters.hpp.


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


ecl_containers
Author(s): Daniel Stonier
autogenerated on Wed Aug 26 2015 11:27:29