Kratos::TableStreamUtility Class Reference

#include <table_stream_utility.h>

Collaboration diagram for Kratos::TableStreamUtility:

Public Member Functions
Type Definitions
	KRATOS_CLASS_POINTER_DEFINITION (TableStreamUtility)
	Counted pointer of TableStreamUtility. More...
Life Cycle
	TableStreamUtility (const bool UseBoldFont=true)
virtual	~TableStreamUtility ()=default
Operations
void	PrintHeader ()
void	PrintFooter ()
template<class TClass >
void	AddToRow (TClass ThisClass)
void	AddColumn (const std::string &ThisName, unsigned int ThisSpaces)
TableStreamType &	GetTable ()
virtual std::string	Info () const
	Turn back information as a string. More...
virtual void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Serialization
class	Serializer

Constructor & Destructor Documentation

TableStreamUtility()

Kratos::TableStreamUtility::TableStreamUtility ( const bool  UseBoldFont = true )

inlineexplicit

The default constructor

~TableStreamUtility()

virtual Kratos::TableStreamUtility::~TableStreamUtility ( )

virtualdefault

Member Function Documentation

AddColumn()

void Kratos::TableStreamUtility::AddColumn ( const std::string &  ThisName, unsigned int  ThisSpaces  )

inline

It adds a column to the table

Parameters

ThisName	The name of the variable
ThisSpaces	The number of spaces to consider

AddToRow()

template<class TClass >

void Kratos::TableStreamUtility::AddToRow ( TClass  ThisClass )

inline

It adds a value to the ouput of the current row

GetTable()

TableStreamType& Kratos::TableStreamUtility::GetTable ( )

inline

It returns the table of BPrinter

Returns

mTable: The table stream table

Info()

virtual std::string Kratos::TableStreamUtility::Info ( ) const

inlinevirtual

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::TableStreamUtility::KRATOS_CLASS_POINTER_DEFINITION

(

TableStreamUtility

)

Counted pointer of TableStreamUtility.

PrintData()

virtual void Kratos::TableStreamUtility::PrintData ( std::ostream &  rOStream ) const

inlinevirtual

Print object's data.

PrintFooter()

void Kratos::TableStreamUtility::PrintFooter ( )

inline

It prints the footer of the table

PrintHeader()

void Kratos::TableStreamUtility::PrintHeader ( )

inline

It prints the header of the table

PrintInfo()

virtual void Kratos::TableStreamUtility::PrintInfo ( std::ostream &  rOStream ) const

inlinevirtual

Print information about this object.

Friends And Related Function Documentation

Serializer

friend class Serializer

friend

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/utilities/table_stream_utility.h