Recorder Class Reference

#include <Recorder.h>

Public Member Functions
	Recorder (std::string recorderName)
	~Recorder (void)
void	markVariable (Object &model, std::string variableName)
void	markStream (Object &model, std::string streamName)
void	store (double moment)
std::ostream &	printCsv (std::ostream &os) const
	print the stored values in tabular form as a semicolon separated (CSV) table More...
const std::string &	name (void) const
	return recorder name More...
void	clear (void)
	delete all data More...

Friends
std::ostream &	operator<< (std::ostream &os, const Recorder &r)
	print the stored values in human-readable form More...

Detailed Description

holds results for a number of variables recorded at distinct moments along a dynamical simulation or along a convergence path

#include <libpf/core/Recorder.h>

Remarks

Warning

Thread safe:

Extendable:

Platform dependencies:

Constructor & Destructor Documentation

Recorder()

Recorder::Recorder ( std::string  recorderName )

explicit

Parameters

recorderName

the recoder descriptive name

~Recorder()

Recorder::~Recorder

(

void

)

Member Function Documentation

clear()

void Recorder::clear

(

void

)

delete all data

markStream()

void Recorder::markStream	(	Object &	model,
		std::string	streamName
	)

mark stream for recording; the following variables are recorded: T, P, Tphase.ndot and the molar fraction vector Tphase.x

Parameters

model	reference to the model where the stream is located
streamName	stream name

markVariable()

void Recorder::markVariable	(	Object &	model,
		std::string	variableName
	)

mark variable for recording

Parameters

model	reference to the model where the variable is located
variableName	full tag string for the variable

name()

const std::string & Recorder::name

(

void

)

const

return recorder name

printCsv()

std::ostream & Recorder::printCsv

(

std::ostream &

os

)

const

print the stored values in tabular form as a semicolon separated (CSV) table

store()

void Recorder::store

(

double

moment

)

store current values of all marked variables

Parameters

moment

a sequential counter or progression indicator (such as time) to identify when the variables are stored

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const Recorder &  r  )

friend

print the stored values in human-readable form

---

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

• Recorder.h