NeuronMonitor Class Reference

#include <neuron_monitor.h>

Public Member Functions
	NeuronMonitor (NeuronMonitorCore *neuronMonitorCorePtr)
	NeuronMonitor constructor. More...
	~NeuronMonitor ()
	NeuronMonitor destructor. More...
void	clear ()
int	getLastUpdated ()
	Returns the ... More...
bool	getPersistentData ()
	Returns a flag that indicates whether PersistentMode is on (true) or off (false) More...
std::vector< std::vector< float > >	getVectorI ()
std::vector< std::vector< float > >	getVectorU ()
std::vector< std::vector< float > >	getVectorV ()
	returns the Neuron state vectors More...
bool	isRecording ()
void	print (bool meanOnly=false)
void	setLogFile (const std::string &logFileName)
void	setPersistentData (bool persistentData)
	Sets PersistentMode either on (true) or off (false) More...
void	startRecording ()
void	stopRecording ()

Detailed Description

Definition at line 62 of file neuron_monitor.h.

Constructor & Destructor Documentation

NeuronMonitor()

NeuronMonitor

(

NeuronMonitorCore *

neuronMonitorCorePtr

)

Creates a new instance of the NeuronMonitor class.

Definition at line 61 of file neuron_monitor.cpp.

~NeuronMonitor()

~NeuronMonitor

(

)

Cleans up all the memory upon object deletion.

Definition at line 66 of file neuron_monitor.cpp.

Member Function Documentation

clear()

void clear

(

)

Definition at line 70 of file neuron_monitor.cpp.

Here is the call graph for this function:

getLastUpdated()

int getLastUpdated

(

)

This function returns

Definition at line 138 of file neuron_monitor.cpp.

Here is the call graph for this function:

getPersistentData()

bool getPersistentData

(

)

This function returns a flag that indicates whether PersistentMode is currently on (true) or off (false). If PersistentMode is off, only the last recording period will be considered for calculating metrics. If PersistentMode is on, all the recording periods will be considered. By default, PersistentMode is off, but can be switched on at any point in time by calling setPersistentData(bool).

Definition at line 129 of file neuron_monitor.cpp.

Here is the call graph for this function:

getVectorI()

std::vector< std::vector< float > > getVectorI

(

)

Definition at line 160 of file neuron_monitor.cpp.

Here is the call graph for this function:

getVectorU()

std::vector< std::vector< float > > getVectorU

(

)

Definition at line 153 of file neuron_monitor.cpp.

Here is the call graph for this function:

getVectorV()

std::vector< std::vector< float > > getVectorV

(

)

Definition at line 146 of file neuron_monitor.cpp.

Here is the call graph for this function:

isRecording()

bool isRecording

(

)

Definition at line 77 of file neuron_monitor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

print()

void print

(

bool

meanOnly = false

)

Definition at line 119 of file neuron_monitor.cpp.

Here is the call graph for this function:

setLogFile()

void setLogFile

(

const std::string &

logFileName

)

Definition at line 95 of file neuron_monitor.cpp.

Here is the call graph for this function:

setPersistentData()

void setPersistentData

(

bool

persistentData

)

This function sets PersistentMode either on (true) or off (false). If PersistentMode is off, only the last recording period will be considered for calculating metrics. If PersistentMode is on, all the recording periods will be considered. By default, PersistentMode is off, but can be switched on at any point in time. The current state of PersistentMode can be retrieved by calling getPersistentData().

Definition at line 133 of file neuron_monitor.cpp.

Here is the call graph for this function:

startRecording()

void startRecording

(

)

Definition at line 81 of file neuron_monitor.cpp.

Here is the call graph for this function:

stopRecording()

void stopRecording

(

)

Definition at line 88 of file neuron_monitor.cpp.

Here is the call graph for this function:

---

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

• neuron_monitor.h
• neuron_monitor.cpp