nest::DynamicRecordablesMap< HostNode > Class Template Reference

Map names of recordables to DataAccessFunctors. More...

#include <recordables_map.h>

Inheritance diagram for nest::DynamicRecordablesMap< HostNode >:

Collaboration diagram for nest::DynamicRecordablesMap< HostNode >:

Public Types
typedef DataAccessFunctor< HostNode >	DataAccessFct
	Datatype for access callable.

Public Member Functions
virtual	~DynamicRecordablesMap ()
void	create (HostNode &n)
	Create the map.
std::vector< std::string >	get_list () const
	Obtain list of all recordables, for use by get_status().
void	insert (const std::string &n, const DataAccessFct &f)
	Insertion functions to be used in create(), adds entry to map and list.
void	erase (const std::string &n)
	Erase functions to be used when setting state, removes entry from map and list.
void	create (cm_default &host)
void	create (iaf_psc_alpha_multisynapse &host)
void	create (iaf_psc_exp_multisynapse &host)

Private Types
typedef std::map< std::string, const DataAccessFunctor< HostNode > >	Base_

Detailed Description

template<typename HostNode>
class nest::DynamicRecordablesMap< HostNode >

Map names of recordables to DataAccessFunctors.

This map identifies the DataAccessFunctors for recordable state variables in multisynapse model neurons. As the number of synapse receptors can be modified at runtime, each neuron shall have its own instance of DynamicRecordablesMap. Furthermore, the neurons are able to insert and erase elements from the map at runtime.

See also

multimeter, UniversalDataLogger

Member Typedef Documentation

Base_

template<typename HostNode >

typedef std::map< std::string, const DataAccessFunctor< HostNode > > nest::DynamicRecordablesMap< HostNode >::Base_

private

DataAccessFct

template<typename HostNode >

typedef DataAccessFunctor< HostNode > nest::DynamicRecordablesMap< HostNode >::DataAccessFct

Datatype for access callable.

Constructor & Destructor Documentation

~DynamicRecordablesMap()

template<typename HostNode >

virtual nest::DynamicRecordablesMap< HostNode >::~DynamicRecordablesMap ( )

inlinevirtual

Member Function Documentation

create() [1/4]

void nest::DynamicRecordablesMap< cm_default >::create

(

cm_default &

host

)

References nest::cm_default::init_recordables_pointers_().

Here is the call graph for this function:

create() [2/4]

template<typename HostNode >

void nest::DynamicRecordablesMap< HostNode >::create

(

HostNode &

n

)

Create the map.

This function must be specialized for each class instance owning a Recordables map and must fill the map. This should happen as part of the original constructor for the Node.

create() [3/4]

void nest::DynamicRecordablesMap< iaf_psc_alpha_multisynapse >::create

(

iaf_psc_alpha_multisynapse &

host

)

References nest::iaf_psc_alpha_multisynapse::get_data_access_functor(), nest::iaf_psc_alpha_multisynapse::State_::I, nest::names::I_syn(), nest::iaf_psc_alpha_multisynapse::insert_current_recordables(), nest::iaf_psc_alpha_multisynapse::State_::V_M, and nest::names::V_m().

Here is the call graph for this function:

create() [4/4]

void nest::DynamicRecordablesMap< iaf_psc_exp_multisynapse >::create

(

iaf_psc_exp_multisynapse &

host

)

References nest::iaf_psc_exp_multisynapse::get_data_access_functor(), nest::iaf_psc_exp_multisynapse::State_::I, nest::names::I_syn(), nest::iaf_psc_exp_multisynapse::insert_current_recordables(), nest::iaf_psc_exp_multisynapse::State_::V_M, and nest::names::V_m().

Here is the call graph for this function:

erase()

template<typename HostNode >

void nest::DynamicRecordablesMap< HostNode >::erase ( const std::string &  n )

inline

Erase functions to be used when setting state, removes entry from map and list.

References nest::find().

Here is the call graph for this function:

get_list()

template<typename HostNode >

std::vector< std::string > nest::DynamicRecordablesMap< HostNode >::get_list ( ) const

inline

Obtain list of all recordables, for use by get_status().

Todo:

This fct should return the recordables_ entry, but since filling recordables_ leads to seg fault on exit, we just build the list every time, even though that beats the goal of being more efficient ...

insert()

template<typename HostNode >

void nest::DynamicRecordablesMap< HostNode >::insert ( const std::string &  n, const DataAccessFct &  f  )

inline

Insertion functions to be used in create(), adds entry to map and list.

---

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

• recordables_map.h