A type of logger that collects some kind of statistic and outputs to a file during or at the end of a simulation. More...

#include <stat_collector.h>

Inheritance diagram for sstmac::stat_collector:

Collaboration diagram for sstmac::stat_collector:

Public Member Functions
virtual	~stat_collector ()

virtual void	simulation_finished (timestamp end)=0
	This is to notify that the statistics collector is done. More...

virtual void	dump_local_data ()=0
	After post-processing, this notifies the collector to dump data to a file. More...

virtual void	dump_global_data ()=0
	After post-processing, this notifies the collector to dump data to a file. More...

virtual void	global_reduce (parallel_runtime *rt)=0

virtual void	reduce (stat_collector *coll)=0

virtual void	clear ()=0

virtual stat_collector *	clone () const =0

virtual std::string	to_string () const

virtual void	init_factory_params (sprockit::sim_parameters *params)

bool	registered () const

virtual void	set_id (int id)

int	id () const

void	set_registered (bool reg)

void	add_suffix (const std::string &suffix)

std::string	fileroot () const

Public Member Functions inherited from sprockit::factory_type
virtual void	init_factory_params (sim_parameters *params)

virtual void	finalize_init ()

Static Public Member Functions
static stat_collector *	optional_build (sprockit::sim_parameters params, const std::string &ns, const std::string &deflt, const char suffix)

Protected Member Functions
	stat_collector ()

void	clone_into (stat_collector *cln) const

Static Protected Member Functions
static bool	check_open (std::fstream &myfile, const std::string &fname, std::ios::openmode flags=std::ios::out)
	Check to see if the file is open. More...

Protected Attributes
bool	registered_

int	id_

std::string	fileroot_

Detailed Description

A type of logger that collects some kind of statistic and outputs to a file during or at the end of a simulation.

Usually, a static instance of this class should be used, because no merging of stat objects takes place, which means you'll get one file for each stat object.

Definition at line 31 of file stat_collector.h.

Constructor & Destructor Documentation

virtual sstmac::stat_collector::~stat_collector ( )

virtual

sstmac::stat_collector::stat_collector ( )

inlineprotected

Definition at line 109 of file stat_collector.h.

References check_open(), and clone_into().

Here is the call graph for this function:

Member Function Documentation

void sstmac::stat_collector::add_suffix ( const std::string & suffix )

Referenced by set_registered().

static bool sstmac::stat_collector::check_open	(	std::fstream &	myfile,
		const std::string &	fname,
		std::ios::openmode	flags = `std::ios::out`
	)

staticprotected

Check to see if the file is open.

If not, try and open it and set the current output stream to it, and throw an sprockit::spkt_error if something goes wrong.

Returns

Referenced by stat_collector().

virtual void sstmac::stat_collector::clear ( )

pure virtual

Implemented in sstmac::hw::stat_bytes_sent, sstmac::sw::ftq_calendar, sstmac::location_trace, sstmac::event_trace, sstmac::stat_spyplot, sstmac::sw::graph_viz, sstmac::stat_histogram, sstmac::stat_global_int, sstmac::stat_local_double, and sstmac::stat_local_int.

virtual stat_collector* sstmac::stat_collector::clone ( ) const

pure virtual

Implemented in sstmac::hw::stat_bytes_sent, sstmac::sw::ftq_calendar, sstmac::stat_spyplot_png, sstmac::stat_spyplot, sstmac::sw::graph_viz, sstmac::event_trace, sstmac::location_trace, sstmac::stat_histogram, sstmac::stat_global_int, sstmac::stat_local_double, and sstmac::stat_local_int.

void sstmac::stat_collector::clone_into ( stat_collector * cln ) const

protected

Referenced by stat_collector().

virtual void sstmac::stat_collector::dump_global_data ( )

pure virtual

After post-processing, this notifies the collector to dump data to a file.

Parameters

name	The root of the filename to dump to

Implemented in sstmac::hw::stat_bytes_sent, sstmac::sw::ftq_calendar, sstmac::sw::graph_viz, sstmac::event_trace, sstmac::stat_spyplot, sstmac::location_trace, sstmac::stat_histogram, sstmac::stat_global_int, sstmac::stat_local_double, and sstmac::stat_local_int.

virtual void sstmac::stat_collector::dump_local_data ( )

pure virtual

After post-processing, this notifies the collector to dump data to a file.

Parameters

name	The root of the filename to dump to

Implemented in sstmac::hw::stat_bytes_sent, sstmac::sw::ftq_calendar, sstmac::sw::graph_viz, sstmac::event_trace, sstmac::stat_spyplot, sstmac::location_trace, sstmac::stat_histogram, sstmac::stat_global_int, sstmac::stat_local_double, and sstmac::stat_local_int.

std::string sstmac::stat_collector::fileroot ( ) const

inline

Definition at line 97 of file stat_collector.h.

References sstmac::hw::routing::deflt, fileroot_, and optional_build().

Here is the call graph for this function:

virtual void sstmac::stat_collector::global_reduce ( parallel_runtime * rt )

pure virtual

Implemented in sstmac::hw::stat_bytes_sent, sstmac::sw::ftq_calendar, sstmac::sw::graph_viz, sstmac::stat_spyplot, sstmac::event_trace, sstmac::location_trace, sstmac::stat_histogram, sstmac::stat_global_int, sstmac::stat_local_double, and sstmac::stat_local_int.

int sstmac::stat_collector::id ( ) const

inline

Definition at line 84 of file stat_collector.h.

References id_.

Referenced by set_id().

virtual void sstmac::stat_collector::init_factory_params ( sprockit::sim_parameters * params )

virtual

Reimplemented in sstmac::hw::stat_bytes_sent, sstmac::sw::ftq_calendar, sstmac::stat_spyplot_png, sstmac::event_trace, sstmac::stat_histogram, sstmac::stat_global_int, sstmac::stat_local_double, and sstmac::stat_local_int.

Referenced by sstmac::stat_spyplot_png::set_normalization(), and to_string().

static stat_collector* sstmac::stat_collector::optional_build	(	sprockit::sim_parameters *	params,
		const std::string &	ns,
		const std::string &	deflt,
		const char *	suffix
	)