sheaf::report Class Reference

A report generating class. More...

#include <report.h>

Public Member Functions
virtual bool	invariant () const
	Class invariant. More...
	report ()
	Default constructor. More...
	report (const namespace_poset *xname_space)
	Namespace constructor. More...
virtual	~report ()
	Destructor. More...
void	start (const std::string &xname)
	Starts a new report with title, xtitle. More...
void	reset ()
	Reset the report. More...
void	point (const std::string &xname)
	Mark a point named, xname, in the report. More...
void	write (const std::string &xfile_name) const
	Write the report to a comma separated value file. More...
const namespace_poset *	name_space () const
	Namespace for the report. More...
std::string	title () const
	Title of the report. More...
stop_watch	watch () const
	Stop watch used to time the report points. More...
block< std::string >	names () const
	Names of the report points. More...
block< size_t >	memory () const
	Deep size of the namespace poset for each point. More...
block< size_t >	memory_part (int lpart) const
	Deep size of the namespace for each component for each point. More...

Detailed Description

A report generating class.

Definition at line 47 of file report.h.

Constructor & Destructor Documentation

report() [1/2]

sheaf::report::report

(

)

Default constructor.

Postcondition

• invariant()

Definition at line 56 of file report.cc.

Referenced by invariant().

report() [2/2]

sheaf::report::report

(

const namespace_poset *

xname_space

)

Namespace constructor.

Precondition

• xname_space != 0 ? xname_space->state_is_read_accessible() : true

Postcondition

• invariant()

Definition at line 76 of file report.cc.

References sheaf::read_write_monitor_handle::state_is_read_accessible(), and ~report().

~report()

sheaf::report::~report ( )

virtual

Destructor.

Definition at line 98 of file report.cc.

References start().

Referenced by report().

Member Function Documentation

invariant()

bool sheaf::report::invariant ( ) const

virtual

Class invariant.

Invariant

• watch().invariant()

• watch().lap_ct() == names().ct()

• name_space() != 0 ? watch().lap_ct() == memory().ct() : true

Definition at line 38 of file report.cc.

References report().

memory()

block<size_t> sheaf::report::memory ( ) const

inline

Deep size of the namespace poset for each point.

Definition at line 135 of file report.h.

Referenced by sheaf::operator<<().

memory_part()

block<size_t> sheaf::report::memory_part ( int  lpart ) const

inline

Deep size of the namespace for each component for each point.

Definition at line 143 of file report.h.

Referenced by sheaf::operator<<().

name_space()

const namespace_poset* sheaf::report::name_space ( ) const

inline

Namespace for the report.

Definition at line 103 of file report.h.

Referenced by sheaf::operator<<().

names()

block<std::string> sheaf::report::names ( ) const

inline

Names of the report points.

Definition at line 127 of file report.h.

Referenced by sheaf::operator<<().

point()

void sheaf::report::point

(

const std::string &

xname

)

Mark a point named, xname, in the report.

Postcondition

• invariant()

Definition at line 158 of file report.cc.

Referenced by reset().

reset()

void sheaf::report::reset

(

)

Reset the report.

Postcondition

• invariant()

Definition at line 133 of file report.cc.

References point().

Referenced by start().

start()

void sheaf::report::start

(

const std::string &

xname

)

Starts a new report with title, xtitle.

Definition at line 115 of file report.cc.

References reset().

Referenced by ~report().

title()

std::string sheaf::report::title ( ) const

inline

Title of the report.

Definition at line 111 of file report.h.

Referenced by sheaf::operator<<().

watch()

stop_watch sheaf::report::watch ( ) const

inline

Stop watch used to time the report points.

Definition at line 119 of file report.h.

Referenced by sheaf::operator<<().

write()

void sheaf::report::write

(

const std::string &

xfile_name

)

const

Write the report to a comma separated value file.

Definition at line 186 of file report.cc.

---

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

• report.h
• report.cc