COOLFluiD  Release kernel
COOLFluiD is a Collaborative Simulation Environment (CSE) focused on complex MultiPhysics simulations.
Public Member Functions | Private Attributes | Friends | List of all members
HistoryEntry Class Reference

Helper class to output one entry to an output stream. More...

#include <History.hpp>

Public Member Functions

 HistoryEntry (const History &history)
 Constructor. More...
 
Handle< math::VariablesDescriptor const > variables () const
 Info for the entry variables. More...
 
const std::vector< Real > & data () const
 The entry data. More...
 
std::string summary () const
 Pretty summary of the form "var1 [value] var2 [value] var3 [value]". More...
 

Private Attributes

std::vector< Real > m_entry
 entry data More...
 
const Historym_history
 history this entry belongs to More...
 

Friends

std::ostream & operator<< (std::ostream &out, const HistoryEntry &history_entry)
 output tab-separated values More...
 

Detailed Description

Helper class to output one entry to an output stream.

Definition at line 169 of file History.hpp.

Constructor & Destructor Documentation

HistoryEntry ( const History history)

Constructor.

Definition at line 336 of file History.cpp.

Member Function Documentation

const std::vector< Real > & data ( ) const

The entry data.

Definition at line 367 of file History.cpp.

std::string summary ( ) const

Pretty summary of the form "var1 [value] var2 [value] var3 [value]".

Definition at line 374 of file History.cpp.

Handle< math::VariablesDescriptor const > variables ( ) const

Info for the entry variables.

Definition at line 360 of file History.cpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const HistoryEntry history_entry 
)
friend

output tab-separated values

Definition at line 390 of file History.cpp.

Member Data Documentation

std::vector<Real> m_entry
private

entry data

Definition at line 189 of file History.hpp.

const History& m_history
private

history this entry belongs to

Definition at line 190 of file History.hpp.


The documentation for this class was generated from the following files:
Send comments to:
COOLFluiD Web Admin