FmtTableOut< T, W > Struct Template Reference

#include <evo/fmt.h>

Detailed Description

template<class T, class W = FmtTable::CachedWriter>
struct evo::FmtTableOut< T, W >

Output interface for writing text table to stream/string.

• This is used to write rows using a FmtTable instance with column information
  • This may update column widths stored in the associated FmtTable if they're too small
• Use fmt_table() or fmt_table_nocache() to get an instance of this type paired with a given string or stream (using type deduction)
• See Additional Formatting

Template Parameters

T	String, Stream, or StreamOut object to write to
W	Writer to use, one of: FmtTable::CachedWriter, or FmtTable::Writer

Public Types
typedef FmtTableOut< T, W >	This
	This type. More...

Public Member Functions
	FmtTableOut (T &out, FmtTable &table, FmtTable::Type type=FmtTable::tTEXT)
	Constructor. More...
	~FmtTableOut ()
	Destructor to finish writing table. More...
This &	operator<< (char val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (const FmtChar &val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (const char *val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (const StringBase &val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (const FmtString &val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (short val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (int val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (long val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (longl val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (ushort val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (uint val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (ulong val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (ulongl val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (float val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (double val)
	Write value for current column in current row and move to next column. More...
This &	operator<< (ldouble val)
	Write value for current column in current row and move to next column. More...
template<class V >
This &	operator<< (const FmtIntT< V > &val)
	Write FmtIntT value for current column in current row and move to next column. More...
template<class V >
This &	operator<< (const FmtFloatT< V > &val)
	Write FmtFloatT value for current column in current row and move to next column. More...
template<class V >
This &	operator<< (const IntegerT< V > &val)
	Write IntegerT value for current column in current row and move to next column. More...
template<class V >
This &	operator<< (const FloatT< V > &val)
	Write FloatT value for current column in current row and move to next column. More...
This &	operator<< (Newline)
	End current row. More...
This &	operator<< (Flush)
	Flush any cached output. More...

Public Attributes
T &	out
	Paired output string/stream to write to. More...
W	writer
	Writer to use with FmtTable. More...

Member Typedef Documentation

This

typedef FmtTableOut<T,W> This

This type.

Constructor & Destructor Documentation

FmtTableOut()

FmtTableOut ( T &  out, FmtTable &  table, FmtTable::Type  type = FmtTable::tTEXT  )

inline

Constructor.

Parameters

out	Output string/stream to write to
table	FmtTable instance to use for column information
type	Output type to use – see FmtTable::Type

~FmtTableOut()

~FmtTableOut ( )

inline

Destructor to finish writing table.

• Caution: In some cases a stream can throw an exception (if enabled) during the flush so it's better to do flush explicitly with operator<<(Flush)

Member Function Documentation

operator<<() [1/22]

This& operator<< ( char  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [2/22]

This& operator<< ( const FmtChar &  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [3/22]

This& operator<< ( const char *  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [4/22]

This& operator<< ( const StringBase &  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [5/22]

This& operator<< ( const FmtString &  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [6/22]

This& operator<< ( short  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [7/22]

This& operator<< ( int  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [8/22]

This& operator<< ( long  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [9/22]

This& operator<< ( longl  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [10/22]

This& operator<< ( ushort  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [11/22]

This& operator<< ( uint  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [12/22]

This& operator<< ( ulong  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [13/22]

This& operator<< ( ulongl  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [14/22]

This& operator<< ( float  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [15/22]

This& operator<< ( double  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [16/22]

This& operator<< ( ldouble  val )

inline

Write value for current column in current row and move to next column.

Parameters

val	Value to write

Returns

This

operator<<() [17/22]

This& operator<< ( const FmtIntT< V > &  val )

inline

Write FmtIntT value for current column in current row and move to next column.

Template Parameters

V	Type used with FmtIntT, inferred from argument

Parameters

val	Value to write

Returns

This

operator<<() [18/22]

This& operator<< ( const FmtFloatT< V > &  val )

inline

Write FmtFloatT value for current column in current row and move to next column.

Template Parameters

V	Type used with FmtFloatT, inferred from argument

Parameters

val	Value to write

Returns

This

operator<<() [19/22]

This& operator<< ( const IntegerT< V > &  val )

inline

Write IntegerT value for current column in current row and move to next column.

• The output will be empty/blank if val is null

Template Parameters

V	Type used with IntegerT, inferred from argument

Parameters

val	Value to write

Returns

This

operator<<() [20/22]

This& operator<< ( const FloatT< V > &  val )

inline

Write FloatT value for current column in current row and move to next column.

• The output will be empty/blank if val is null

Template Parameters

V	Type used with FloatT, inferred from argument

Parameters

val	Value to write

Returns

This

operator<<() [21/22]

This& operator<< ( Newline  )

inline

End current row.

• This may be used to end the row early (leaving empty/blank cells)
• The will end automatically on the last column so this is optional, but preferred to be explicit
• Pass argument as NL

Returns

This

operator<<() [22/22]

This& operator<< ( Flush  )

inline

Flush any cached output.

• Caution: In some cases a stream can throw an exception (if enabled) during the flush so it's better to do flush explicitly with this
• Pass argument as fFLUSH

Member Data Documentation

out

T& out

Paired output string/stream to write to.

writer

W writer

Writer to use with FmtTable.

---

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

• evo/fmt.h