Classes | Functions
ecl::formatters Namespace Reference

Supporting classes for container formatters (do not use directly). More...

Classes

class  ArrayFormatter
 Pseudo formatter for integral type arrays. More...
 
class  ArrayFormatter< char, N >
 Convenience formatter for viewing a char array in hex format. More...
 
class  ArrayFormatter< double, N >
 Formatter for fixed size double arrays. More...
 
class  ArrayFormatter< float, N >
 Formatter for fixed size float arrays. More...
 
class  ArrayFormatter< signed char, N >
 Convenience formatter for viewing a signed char array in hex format. More...
 
class  ArrayFormatter< unsigned char, N >
 Convenience formatter for viewing an unsigned char array in hex format. More...
 
class  ByteArrayFormatter
 Parent template for the byte array formatters. More...
 
class  BytePushAndPopFormatter
 Parent template for the byte push and pop formatters. More...
 
class  FloatContainerFormatter
 Parent interface for formatters of fixed size float/double containers. More...
 
class  PushAndPopFormatter
 Pseudo formatter for integral type arrays. More...
 
class  PushAndPopFormatter< unsigned char, N >
 Convenience formatter for viewing an unsigned char push and pop containers in hex format. More...
 
class  StencilFormatter
 Pseudo formatter for stencils. More...
 
class  StencilFormatter< ValueType, Container, ecl::enable_if< ecl::is_float< ValueType > >::type >
 Partial specialisation of the stencil formatter for float containers. More...
 

Functions

template<typename OutputStream , typename CharType , size_t M>
OutputStream & operator<< (OutputStream &ostream, const BytePushAndPopFormatter< CharType, M > &formatter)
 
template<typename OutputStream , typename CharType , size_t M>
OutputStream & operator<< (OutputStream &ostream, const ByteArrayFormatter< CharType, M > &formatter)
 
template<typename OutputStream , typename Container_ >
OutputStream & operator<< (OutputStream &ostream, FloatContainerFormatter< Container_ > &formatter)
 

Detailed Description

Supporting classes for container formatters (do not use directly).

Do not use these directly, they are better accessed via the Container::Formatter or Format< Container > mechanisms.

Function Documentation

◆ operator<<() [1/3]

template<typename OutputStream , typename CharType , size_t M>
OutputStream& ecl::formatters::operator<< ( OutputStream &  ostream,
const BytePushAndPopFormatter< CharType, M > &  formatter 
)

Insertion operator for sending the formatter (for character arrays) to an output stream.

Template Parameters
OutputStream: the type of the output stream to be inserted into.
M: the size of the container to be formatted.
Parameters
ostream: the output stream.
formatter: the formatter to be inserted.
Returns
OutputStream : continue streaming with the updated output stream.
Exceptions
StandardException: throws if the formatter is used multiply in one stream operation [debug mode only].

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

◆ operator<<() [2/3]

template<typename OutputStream , typename CharType , size_t M>
OutputStream& ecl::formatters::operator<< ( OutputStream &  ostream,
const ByteArrayFormatter< CharType, M > &  formatter 
)

Insertion operator for sending the formatter (for character arrays) to an output stream.

Template Parameters
OutputStream: the type of the output stream to be inserted into.
M: the size of the container to be formatted.
Parameters
ostream: the output stream.
formatter: the formatter to be inserted.
Returns
OutputStream : continue streaming with the updated output stream.
Exceptions
StandardException: throws if the formatter is used multiply in one stream operation [debug mode only].

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

◆ operator<<() [3/3]

template<typename OutputStream , typename Container_ >
OutputStream& ecl::formatters::operator<< ( OutputStream &  ostream,
FloatContainerFormatter< Container_ > &  formatter 
)
Parameters
ostream: the output stream.
formatter: the formatter to be inserted.
Returns
OutputStream : continue streaming with the updated output stream.
Exceptions
StandardException: throws if the formatter is used multiply in one stream operation [debug mode only].

Definition at line 216 of file common/formatters.hpp.



ecl_containers
Author(s): Daniel Stonier
autogenerated on Mon Feb 28 2022 22:18:43