auryn::Monitor Class Reference

Abstract base class for all Monitor objects. More...

#include <Monitor.h>

Inheritance diagram for auryn::Monitor:

Collaboration diagram for auryn::Monitor:

Public Member Functions
virtual void	flush ()
	Flush to file. More...
	Monitor (std::string filename, std::string default_extension="dat")
	Standard constructor with file name. More...
	Monitor ()
	Constructor which does not open a text file for output. More...
std::string	generate_filename (std::string name_hint="")
	Generates a default filename from the device ID. More...
virtual	~Monitor ()
	Standard destructor. More...
Public Member Functions inherited from auryn::Device
	Device ()
	Standard constructor. More...
void	set_name (std::string s)
	Set device name. More...
std::string	get_name ()
	Get device name. More...
int	get_id ()
	Get numeric device id. More...
virtual	~Device ()
	Standard destructor. More...
virtual void	evolve ()
virtual void	execute ()

Public Attributes
bool	active
	Standard active switch. More...
Public Attributes inherited from auryn::Device
bool	active
	Standard active switch. More...

Protected Member Functions
virtual void	open_output_file (std::string filename)
virtual void	virtual_serialize (boost::archive::binary_oarchive &ar, const unsigned int version)
virtual void	virtual_serialize (boost::archive::binary_iarchive &ar, const unsigned int version)
Protected Member Functions inherited from auryn::Device
void	init ()
	Standard initializer to be called by the constructor. More...

Protected Attributes
std::ofstream	outfile
std::string	fname
std::string	default_file_extension
Protected Attributes inherited from auryn::Device
std::string	device_name
	Identifying name for device. More...

Detailed Description

Abstract base class for all Monitor objects.

This Class constitutes the base class for all Monitors in Auryn. Per default it openes a single text file for writing (outfile) named by the name supplied in the constructor. Classes inheriting from Monitor have to implement the method execute. Unlike Checker objects execute returns void. Use Checker if you need the Monitor to be able to interrupt a run.

Constructor & Destructor Documentation

Monitor() [1/2]

Monitor::Monitor	(	std::string	filename,
		std::string	default_extension = "dat"
	)

Standard constructor with file name.

                                                                  : Device()
{
        default_file_extension = default_extension;
        init(filename);
}

Here is the call graph for this function:

Monitor() [2/2]

Monitor::Monitor

(

)

Constructor which does not open a text file for output.

                  : Device()
{
        default_file_extension = "dat";
}

~Monitor()

Monitor::~Monitor ( )

virtual

Standard destructor.

{
        free();
}

Member Function Documentation

flush()

void Monitor::flush ( )

virtual

Flush to file.

Reimplemented from auryn::Device.

Reimplemented in auryn::BinarySpikeMonitor.

{
        outfile.flush();
}

generate_filename()

std::string Monitor::generate_filename

(

std::string

name_hint = ""

)

Generates a default filename from the device ID.

{
        std::stringstream oss;
        oss << get_name() << name_hint;
        std::string tmpstr = oss.str(); 
        tmpstr.erase(std::remove(tmpstr.begin(),tmpstr.end(),' '),tmpstr.end());
        std::transform(tmpstr.begin(), tmpstr.end(), tmpstr.begin(), ::tolower);
        tmpstr = sys->fn(tmpstr, default_file_extension);
        // std::cout << tmpstr << std::endl;
        return tmpstr;
}

Here is the call graph for this function:

open_output_file()

void Monitor::open_output_file ( std::string  filename )

protectedvirtual

Opens a text outputfile – for binary files redefine this function in derived class.

{
        outfile.open( filename.c_str(), std::ios::out );
        if (!outfile) {
          std::stringstream oss;
          oss << "Can't open output file " << filename;
          auryn::logger->msg(oss.str(),ERROR);
          exit(1);
        }
}

Here is the call graph for this function:

virtual_serialize() [1/2]

void Monitor::virtual_serialize ( boost::archive::binary_oarchive &  ar, const unsigned int  version  )

protectedvirtual

Functions necesssary for serialization and loading saving to netstate files.

Reimplemented from auryn::Device.

Reimplemented in auryn::BurstRateMonitor, auryn::PatternMonitor, and auryn::PopulationRateMonitor.

{
        Device::virtual_serialize(ar, version);
}

Here is the call graph for this function:

virtual_serialize() [2/2]

void Monitor::virtual_serialize ( boost::archive::binary_iarchive &  ar, const unsigned int  version  )

protectedvirtual

Reimplemented from auryn::Device.

Reimplemented in auryn::BurstRateMonitor, auryn::PatternMonitor, and auryn::PopulationRateMonitor.

{
        Device::virtual_serialize(ar, version);
}

Here is the call graph for this function:

Member Data Documentation

active

bool auryn::Monitor::active

Standard active switch.

default_file_extension

std::string auryn::Monitor::default_file_extension

protected

Default extension

fname

std::string auryn::Monitor::fname

protected

Stores output filename

outfile

std::ofstream auryn::Monitor::outfile

protected

Output filestream to be used in the derived classes

---

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

• /home/zenke/auryn/src/auryn/Monitor.h
• /home/zenke/auryn/src/auryn/Monitor.cpp