Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
spore::ConnectionDataLoggerBase Class Reference

Base class to all data loggers for connections. More...

#include <connection_data_logger.h>

Inheritance diagram for spore::ConnectionDataLoggerBase:
Inheritance graph
[legend]

Classes

struct  RecorderData
 Data structure that holds the recorded data. More...
 

Public Types

typedef nest::index recorder_port
 

Public Member Functions

 ConnectionDataLoggerBase ()
 
 ~ConnectionDataLoggerBase ()
 
void get_status (DictionaryDatum &d, recorder_port port) const
 
void set_status (const DictionaryDatum &d, recorder_port &port)
 
void clear ()
 

Protected Member Functions

recorder_port add_recordable_connection ()
 

Protected Attributes

std::vector< RecorderData *> recorder_data_
 
std::vector< Name > recorder_names_
 

Detailed Description

Base class to all data loggers for connections.

Constructor & Destructor Documentation

◆ ConnectionDataLoggerBase()

spore::ConnectionDataLoggerBase::ConnectionDataLoggerBase ( )

Constructor.

◆ ~ConnectionDataLoggerBase()

spore::ConnectionDataLoggerBase::~ConnectionDataLoggerBase ( )

Destructor.

Member Function Documentation

◆ add_recordable_connection()

ConnectionDataLoggerBase::recorder_port spore::ConnectionDataLoggerBase::add_recordable_connection ( )
protected

Add new recordable connection to the recorder.

Returns
the port id of the new recorder.

◆ clear()

void spore::ConnectionDataLoggerBase::clear ( )

Clears all recorded data.

◆ get_status()

void spore::ConnectionDataLoggerBase::get_status ( DictionaryDatum &  d,
recorder_port  port 
) const

Get recorded values of recorder at given port.

Parameters
ddictionary to retrieve data.
portrecorder port of the calling connection.

◆ set_status()

void spore::ConnectionDataLoggerBase::set_status ( const DictionaryDatum &  d,
recorder_port &  port 
)

Set the status of the recorder at given port. The recorder port may change to a new value during this call.

Parameters
ddictionary of parameter values.
portrecorder port of the calling connection.

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