Public Types | Public Member Functions | List of all members
spore::ConnectionDataLogger< ConnectionType > Class Template Reference

Generic version of data logger for connections. More...

#include <connection_data_logger.h>

Inheritance diagram for spore::ConnectionDataLogger< ConnectionType >:
Inheritance graph
[legend]
Collaboration diagram for spore::ConnectionDataLogger< ConnectionType >:
Collaboration graph
[legend]

Public Types

typedef double(ConnectionType::* DataAccessFct) () const
 
- Public Types inherited from spore::ConnectionDataLoggerBase
typedef nest::index recorder_port
 

Public Member Functions

void register_recordable_variable (const Name &name, DataAccessFct data_access_fct)
 
void record (double time, ConnectionType const &host, recorder_port port)
 
- Public Member Functions inherited from spore::ConnectionDataLoggerBase
 ConnectionDataLoggerBase ()
 
 ~ConnectionDataLoggerBase ()
 
void get_status (DictionaryDatum &d, recorder_port port) const
 
void set_status (const DictionaryDatum &d, recorder_port &port)
 
void clear ()
 

Additional Inherited Members

- Protected Member Functions inherited from spore::ConnectionDataLoggerBase
recorder_port add_recordable_connection ()
 
- Protected Attributes inherited from spore::ConnectionDataLoggerBase
std::vector< RecorderData *> recorder_data_
 
std::vector< Name > recorder_names_
 

Detailed Description

template<typename ConnectionType>
class spore::ConnectionDataLogger< ConnectionType >

Generic version of data logger for connections.

Member Function Documentation

◆ record()

template<typename ConnectionType >
void spore::ConnectionDataLogger< ConnectionType >::record ( double  time_step,
ConnectionType const &  host,
recorder_port  port 
)

Record current variable values from the given host connection. Values are recorded only if the last recording time is older than the recorder interval.

Parameters
timecurrent time of recording.
hostthe host connection.
portthe recorder port of the host connection.

◆ register_recordable_variable()

template<typename ConnectionType >
void spore::ConnectionDataLogger< ConnectionType >::register_recordable_variable ( const Name &  name,
DataAccessFct  data_access_fct 
)

Add a new recordable variable to the recorder object.

Parameters
namename of the recordable variable.
data_access_fctpointer to the member function to retrieve the variable.

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