nest::CommonSynapseProperties Class Reference

Class containing the common properties for all connections of a certain type. More...

#include <common_synapse_properties.h>

Inheritance diagram for nest::CommonSynapseProperties:

Collaboration diagram for nest::CommonSynapseProperties:

Public Member Functions
	CommonSynapseProperties ()
	Standard constructor.
	~CommonSynapseProperties ()
void	get_status (Dictionary &d) const
	Get all properties and put them into a dictionary.
void	set_status (const Dictionary &d, ConnectorModel &cm)
	Set properties from the values given in dictionary.
void	calibrate (const TimeConverter &)
	Calibrate all time objects, which might be contained in this object.
long	get_vt_node_id () const
	Get node ID of volume transmitter.
weight_recorder *	get_weight_recorder () const
	Get weight_recorder.

Private Attributes
weight_recorder *	weight_recorder_

Detailed Description

Class containing the common properties for all connections of a certain type.

Everything that needs to be stored commonly for all synapses goes into a CommonProperty class derived from this base class. Base class for all CommonProperty classes. If the synapse type does not have any common properties, this class may be used as a placeholder.

Constructor & Destructor Documentation

CommonSynapseProperties()

nest::CommonSynapseProperties::CommonSynapseProperties

(

)

Standard constructor.

Sets all common properties to default values. Default implementation of an empty CommonSynapseProperties object.

~CommonSynapseProperties()

nest::CommonSynapseProperties::~CommonSynapseProperties

(

)

Member Function Documentation

calibrate()

void nest::CommonSynapseProperties::calibrate

(

const TimeConverter &

)

Calibrate all time objects, which might be contained in this object.

get_status()

void nest::CommonSynapseProperties::get_status

(

Dictionary &

d

)

const

Get all properties and put them into a dictionary.

References nest::NodeCollection::create(), nest::names::weight_recorder(), and weight_recorder_.

Referenced by nest::EpropSynapseCommonProperties::get_status(), nest::EpropSynapseBSSHSLM2020CommonProperties::get_status(), nest::JonkeCommonProperties::get_status(), nest::STDPDopaCommonProperties::get_status(), nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::get_status(), nest::STDPPLHomCommonProperties::get_status(), nest::STDPHomCommonProperties::get_status(), and nest::CommonPropertiesHomW::get_status().

Here is the call graph for this function:

Here is the caller graph for this function:

get_vt_node_id()

long nest::CommonSynapseProperties::get_vt_node_id ( ) const

inline

Get node ID of volume transmitter.

get_weight_recorder()

weight_recorder * nest::CommonSynapseProperties::get_weight_recorder ( ) const

inline

Get weight_recorder.

References weight_recorder_.

Referenced by nest::Connector< ConnectionT >::send_weight_event().

Here is the caller graph for this function:

set_status()

void nest::CommonSynapseProperties::set_status	(	const Dictionary &	d,
		ConnectorModel &	cm
	)

Set properties from the values given in dictionary.

References nest::NodeManager::get_node_or_proxy(), nest::VPManager::get_thread_id(), nest::kernel(), nest::KernelManager::node_manager, nest::KernelManager::vp_manager, nest::names::weight_recorder(), and weight_recorder_.

Referenced by nest::EpropSynapseCommonProperties::set_status(), nest::EpropSynapseBSSHSLM2020CommonProperties::set_status(), nest::JonkeCommonProperties::set_status(), nest::STDPDopaCommonProperties::set_status(), nest::STDPFACETSHWHomCommonProperties< targetidentifierT >::set_status(), nest::STDPPLHomCommonProperties::set_status(), nest::STDPHomCommonProperties::set_status(), and nest::CommonPropertiesHomW::set_status().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

weight_recorder_

weight_recorder* nest::CommonSynapseProperties::weight_recorder_

private

Referenced by get_status(), get_weight_recorder(), and set_status().

---

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

• common_synapse_properties.h
• common_synapse_properties.cpp