nest::ConnectionLabel< ConnectionT > Class Template Reference

The class ConnectionLabel enables synapse model to be labeled by a positive integer. More...

#include <connection_label.h>

Inheritance diagram for nest::ConnectionLabel< ConnectionT >:

Collaboration diagram for nest::ConnectionLabel< ConnectionT >:

Public Member Functions
	ConnectionLabel ()
void	get_status (Dictionary &d) const
	Get all properties of this connection and put them into a dictionary.
void	set_status (const Dictionary &d, ConnectorModel &cm)
	Set properties of this connection from the values given in dictionary.
long	get_label () const

Private Attributes
long	label_

Detailed Description

template<typename ConnectionT>
class nest::ConnectionLabel< ConnectionT >

The class ConnectionLabel enables synapse model to be labeled by a positive integer.

The label can be set / retrieved with the names::synapse_label property in the parameter dictionary of Set/GetStatus or Connect. Using the GetConnections function, synapses with the same label can be specified.

The name of synapse models, which can be labeled, end with '_lbl'.

See also

nest::ConnectionManager::get_connections

Constructor & Destructor Documentation

ConnectionLabel()

template<typename ConnectionT >

nest::ConnectionLabel< ConnectionT >::ConnectionLabel

(

)

Member Function Documentation

get_label()

template<typename ConnectionT >

long nest::ConnectionLabel< ConnectionT >::get_label ( ) const

inline

get_status()

template<typename ConnectionT >

void nest::ConnectionLabel< ConnectionT >::get_status

(

Dictionary &

d

)

const

Get all properties of this connection and put them into a dictionary.

References nest::names::size_of(), and nest::names::synapse_label().

Here is the call graph for this function:

set_status()

template<typename ConnectionT >

void nest::ConnectionLabel< ConnectionT >::set_status	(	const Dictionary &	d,
		ConnectorModel &	cm
	)

Set properties of this connection from the values given in dictionary.

Note

Target and Rport cannot be changed after a connection has been created.

References nest::names::synapse_label().

Here is the call graph for this function:

Member Data Documentation

label_

template<typename ConnectionT >

long nest::ConnectionLabel< ConnectionT >::label_

private

---

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

• connection_label.h