Inheritance diagram for XmlRecorder:

[legend]

Collaboration diagram for XmlRecorder:

Classes
struct	singleVariableInfo

Public Member Functions
virtual void	init () override
	Initialize data in the newly loadeded xml file.

virtual void	term () override
	Terminate process.

virtual void	compileHistories () override
	Compile/capture variable history information in every epoch.

virtual void	saveSimData () override
	Writes simulation results to an output destination.

virtual void	printParameters () override

virtual void	registerVariable (const string &varName, RecordableBase &recordVar, UpdatedType variableType) override
	Registers a single instance of a class derived from RecordableBase.

virtual void	registerVariable (const string &varName, vector< RecordableBase * > &recordVars, UpdatedType variableType) override
	Register a vector of instance of a class derived from RecordableBase.


	XmlRecorder (const string &fileName)
	constructor only for unit test

const string &	getVariableName (int numIndex) const

const string &	getDataType (int numIndex) const

RecordableBase &	getSingleVariable (int numIndex)

vector< multipleTypes > &	getHistory (int numIndex)
	Accessor method for variablesHistory_ (only included during unit tests)

string	getToXML (const string &name, vector< multipleTypes > &singleVariableBuffer_, const string &basicType)
	get an output stream from toXml method (only included during unit tests)

Public Member Functions inherited from Recorder

Static Public Member Functions
static Recorder *	Create ()

Protected Member Functions
string	toXML (const string &name, vector< multipleTypes > &singleVariableBuffer_, const string &basicType) const
	Retrieves values of a vector of variant and outputs them to a xml file.

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

Protected Member Functions inherited from Recorder

Protected Attributes
vector< singleVariableInfo >	variableTable_
	List of registered variables for recording.

ofstream	resultOut_
	a file stream for xml output

Protected Attributes inherited from Recorder
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.

Additional Inherited Members
Public Types inherited from Recorder
enum	UpdatedType { CONSTANT , DYNAMIC }
	The recorded variable Type/Updated frequency. More...

Detailed Description

Definition at line 35 of file XmlRecorder.h.

Constructor & Destructor Documentation

◆ XmlRecorder() [1/2]

XmlRecorder::XmlRecorder ( )

Definition at line 19 of file XmlRecorder.cpp.

◆ XmlRecorder() [2/2]

XmlRecorder::XmlRecorder ( const string & fileName )

inline

constructor only for unit test

These methods are intended only for unit tests

Definition at line 81 of file XmlRecorder.h.

Member Function Documentation

◆ compileHistories()

void XmlRecorder::compileHistories ( )

overridevirtual

Compile/capture variable history information in every epoch.

Compile history information in every epoch.

Implements Recorder.

Reimplemented in Xml911Recorder.

Definition at line 59 of file XmlRecorder.cpp.

◆ Create()

static Recorder * XmlRecorder::Create ( )

inlinestatic

Definition at line 40 of file XmlRecorder.h.

◆ getDataType()

const string & XmlRecorder::getDataType ( int numIndex ) const

inline

Accessor method for variable data type (only included during unit tests)

Parameters

numIndex The index number in the variable list.

Definition at line 95 of file XmlRecorder.h.

◆ getHistory()

vector< multipleTypes > & XmlRecorder::getHistory ( int numIndex )

inline

Accessor method for variablesHistory_ (only included during unit tests)

Definition at line 109 of file XmlRecorder.h.

◆ getSingleVariable()

RecordableBase & XmlRecorder::getSingleVariable ( int numIndex )

inline

Accessor method for a single variable address in the variableTable_

Parameters

numIndex The index number in the variable list. (only included during unit tests)

Definition at line 103 of file XmlRecorder.h.

◆ getStarterNeuronMatrix()

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

protectedvirtual

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.

Implements Recorder.

Definition at line 131 of file XmlRecorder.cpp.

◆ getToXML()

string XmlRecorder::getToXML	(	const string &	name,
		vector< multipleTypes > &	singleVariableBuffer_,
		const string &	basicType )

inline

get an output stream from toXml method (only included during unit tests)

Definition at line 115 of file XmlRecorder.h.

◆ getVariableName()

const string & XmlRecorder::getVariableName ( int numIndex ) const

inline

Accessor method for variable name (only included during unit tests)

Parameters

numIndex The index number in the variable list.

Definition at line 88 of file XmlRecorder.h.

◆ init()

void XmlRecorder::init ( )

overridevirtual

Initialize data in the newly loadeded xml file.

Create a new xml file and initialize data

Parameters

[in] stateOutputFileName File name to save histories

Implements Recorder.

Definition at line 31 of file XmlRecorder.cpp.

◆ printParameters()

void XmlRecorder::printParameters ( )

overridevirtual

Prints out all parameters to logging file. Registered to OperationManager as Operation::printParameters

Implements Recorder.

Reimplemented in Xml911Recorder.

Definition at line 139 of file XmlRecorder.cpp.

◆ registerVariable() [1/2]

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

overridevirtual

Registers a single instance of a class derived from RecordableBase.

Receives a recorded variable entity from the variable owner class.

Receives a recorded variable entity from the variable owner class Used when the return type from recordable variable is supported by Recorder

Parameters

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

Registers a single instance of a class derived from RecordableBase.

Parameters

varName	Name of the recorded variable.
recordVar	Reference to the recorded variable.
variableType	Type of the recorded variable.

Implements Recorder.

Definition at line 153 of file XmlRecorder.cpp.

◆ registerVariable() [2/2]

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

overridevirtual

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

Register a vector of instances of classes derived from RecordableBase.

This method allows the XmlRecorder to store a vector of variables, each represented by an address and a unique variable name. It is typically used to register multiple instances of a class derived from RecordableBase.

Parameters

varName	The name associated with the registered variables.
recordVars	A vector of pointers to RecordableBase objects to be registered.

Implements Recorder.

Definition at line 168 of file XmlRecorder.cpp.

◆ saveSimData()

void XmlRecorder::saveSimData ( )

overridevirtual

Writes simulation results to an output destination.

Implements Recorder.

Reimplemented in Xml911Recorder.

Definition at line 72 of file XmlRecorder.cpp.

◆ term()

void XmlRecorder::term ( )

overridevirtual

Terminate process.

Implements Recorder.

Definition at line 52 of file XmlRecorder.cpp.

◆ toXML()

string XmlRecorder::toXML	(	const string &	name,
		vector< multipleTypes > &	singleVariableBuffer_,
		const string &	basicType ) const

protected

Retrieves values of a vector of variant and outputs them to a xml file.

Definition at line 95 of file XmlRecorder.cpp.

Member Data Documentation

◆ resultOut_

ofstream XmlRecorder::resultOut_

protected

a file stream for xml output

Definition at line 169 of file XmlRecorder.h.

◆ variableTable_

vector<singleVariableInfo> XmlRecorder::variableTable_

protected

List of registered variables for recording.

Definition at line 166 of file XmlRecorder.h.

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

Simulator/Recorders/XmlRecorder.h
Simulator/Recorders/XmlRecorder.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XmlRecorder() [1/2]

◆ XmlRecorder() [2/2]

Member Function Documentation

◆ compileHistories()

◆ Create()

◆ getDataType()

◆ getHistory()

◆ getSingleVariable()

◆ getStarterNeuronMatrix()

◆ getToXML()

◆ getVariableName()

◆ init()

◆ printParameters()

◆ registerVariable() [1/2]

◆ registerVariable() [2/2]

◆ saveSimData()

◆ term()

◆ toXML()

Member Data Documentation

◆ resultOut_

◆ variableTable_