dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
Dune::Fem::NumberColumnWriter< DataTuple, DataSource > Class Template Reference

gets the N th element of a provided tuple assuming its a number More...

#include <dune/fem/io/file/latextablewriter.hh>

Inheritance diagram for Dune::Fem::NumberColumnWriter< DataTuple, DataSource >:
Inheritance graph

Public Types

enum  Alignment { AlignLeft , AlignCenter , AlignRight }
 The alignment for the data in this column. More...
 

Public Member Functions

 NumberColumnWriter (const std::string &header, const int decimals=6, const DataSource &source=DataSource())
 
 NumberColumnWriter (const std::string &header, const DataSource &source)
 Constructor of NumberColumnWriter where decimal default to 6.
 
BaseType::Alignment alignment () const
 set the aligment of the entries for this column in the latex table
 
std::string entry (const DataTuple &data) const
 returns N the element from data tuple
 
std::string header () const
 return Column titles in latex row format
 

Protected Member Functions

template<class Number >
std::string toString (const Number &number) const
 converts number to std::string
 

Detailed Description

template<class DataTuple, class DataSource>
class Dune::Fem::NumberColumnWriter< DataTuple, DataSource >

gets the N th element of a provided tuple assuming its a number

This class extracts the N th element of the tuple assuming the N th element is a number

Template Parameters
DataTupleThe type of the data tuple
NIndex of the entry in the data tuple tp be extracted

Member Enumeration Documentation

◆ Alignment

template<class DataTuple >
enum Dune::Fem::AbstractColumnWriter::Alignment
inherited

The alignment for the data in this column.

Enumerator
AlignLeft 
AlignCenter 
AlignRight 

Constructor & Destructor Documentation

◆ NumberColumnWriter() [1/2]

template<class DataTuple , class DataSource >
Dune::Fem::NumberColumnWriter< DataTuple, DataSource >::NumberColumnWriter ( const std::string &  header,
const int  decimals = 6,
const DataSource &  source = DataSource() 
)
inlineexplicit

Constructor

Parameters
[in]headerColumn titles in latex row format
[in]decimalsThe precision of double for output to latex table
[in]sourceThe type of the data to be written in column(s)

◆ NumberColumnWriter() [2/2]

template<class DataTuple , class DataSource >
Dune::Fem::NumberColumnWriter< DataTuple, DataSource >::NumberColumnWriter ( const std::string &  header,
const DataSource &  source 
)
inline

Constructor of NumberColumnWriter where decimal default to 6.

Constructor

Parameters
[in]headerColumn titles in latex row format
[in]sourceThe type of the data to be written in column(s)

Member Function Documentation

◆ alignment()

template<class DataTuple , class DataSource >
BaseType::Alignment Dune::Fem::NumberColumnWriter< DataTuple, DataSource >::alignment ( ) const
inlinevirtual

set the aligment of the entries for this column in the latex table

Reimplemented from Dune::Fem::AbstractColumnWriter< DataTuple >.

◆ entry()

template<class DataTuple , class DataSource >
std::string Dune::Fem::NumberColumnWriter< DataTuple, DataSource >::entry ( const DataTuple &  data) const
inlinevirtual

returns N the element from data tuple

Returns
String representing N th element of data
Note
N th element of data is assumed to be number

Implements Dune::Fem::AbstractColumnWriter< DataTuple >.

◆ header()

template<class DataTuple , class DataSource >
std::string Dune::Fem::NumberColumnWriter< DataTuple, DataSource >::header ( ) const
inlinevirtual

return Column titles in latex row format

Implements Dune::Fem::AbstractColumnWriter< DataTuple >.

◆ toString()

template<class DataTuple , class DataSource >
template<class Number >
std::string Dune::Fem::NumberColumnWriter< DataTuple, DataSource >::toString ( const Number &  number) const
inlineprotected

converts number to std::string


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