Recorder Class Reference

Inheritance diagram for Recorder:

Public Types
enum	UpdatedType { CONSTANT , DYNAMIC }
	The recorded variable Type/Updated frequency. More...

Public Member Functions
virtual void	init ()=0
virtual void	term ()=0
	Terminate process.
virtual void	compileHistories ()=0
	Compile/capture variable history information in every epoch.
virtual void	saveSimData ()=0
	Writes simulation results to an output destination.
virtual void	printParameters ()=0
	Prints loaded parameters to logging file.
virtual void	registerVariable (const string &varName, RecordableBase &recordVar, UpdatedType variableType)=0
	Receives a recorded variable entity from the variable owner class.
virtual void	registerVariable (const string &varName, vector< RecordableBase * > &recordVars, UpdatedType variableType)=0
	Register a vector of instance of a class derived from RecordableBase.

Protected Member Functions
virtual void	getStarterNeuronMatrix (VectorMatrix &matrix, const vector< bool > &starterMap)=0

Protected Attributes
string	resultFileName_
	File path to the file that the results will be printed to.
log4cplus::Logger	fileLogger_
	Loggers used to print to using log4cplus logging macros, prints to Results/Debug/logging.txt.

Detailed Description

Definition at line 26 of file Recorder.h.

Member Enumeration Documentation

UpdatedType

enum Recorder::UpdatedType

The recorded variable Type/Updated frequency.

Definition at line 29 of file Recorder.h.

Member Function Documentation

compileHistories()

virtual void Recorder::compileHistories ( )

pure virtual

Compile/capture variable history information in every epoch.

Implemented in Xml911Recorder, and XmlRecorder.

getStarterNeuronMatrix()

virtual void Recorder::getStarterNeuronMatrix ( VectorMatrix & matrix, const vector< bool > & starterMap )

protectedpure virtual

Populates Starter neuron matrix based with boolean values based on starterMap state

Parameters

[in]	matrix	starter neuron matrix
	starterMap	Bool map to reference neuron matrix location from.

Implemented in XmlRecorder.

init()

virtual void Recorder::init ( )

pure virtual

Initialize data

Parameters

[in]

stateOutputFileName

File name to save histories

Implemented in XmlRecorder.

printParameters()

virtual void Recorder::printParameters ( )

pure virtual

Prints loaded parameters to logging file.

Implemented in Xml911Recorder, and XmlRecorder.

registerVariable() [1/2]

virtual void Recorder::registerVariable ( const string & varName, RecordableBase & recordVar, UpdatedType variableType )

pure virtual

Receives a recorded variable entity from the variable owner class.

Registers a single instance of a class derived from RecordableBase.

Parameters

varName	Name of the recorded variable.
recordVar	Reference to the recorded variable.
variableType	Updated frequency of the recorded variable.

Implemented in XmlRecorder.

registerVariable() [2/2]

virtual void Recorder::registerVariable ( const string & varName, vector< RecordableBase * > & recordVars, UpdatedType variableType )

pure virtual

Register a vector of instance of a class derived from RecordableBase.

Implemented in XmlRecorder.

saveSimData()

virtual void Recorder::saveSimData ( )

pure virtual

Writes simulation results to an output destination.

Implemented in Xml911Recorder, and XmlRecorder.

term()

virtual void Recorder::term ( )

pure virtual

Terminate process.

Implemented in XmlRecorder.

Member Data Documentation

fileLogger_

log4cplus::Logger Recorder::fileLogger_

protected

Loggers used to print to using log4cplus logging macros, prints to Results/Debug/logging.txt.

Definition at line 75 of file Recorder.h.

resultFileName_

string Recorder::resultFileName_

protected

File path to the file that the results will be printed to.

Definition at line 72 of file Recorder.h.

---

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

• Simulator/Recorders/Recorder.h