nest::StaticConnection< targetidentifierT > Class Template Reference

Class representing a static connection. More...

#include <static_connection.h>

Inheritance diagram for nest::StaticConnection< targetidentifierT >:

Classes
class	ConnTestDummyNode

Public Types
typedef CommonSynapseProperties	CommonPropertiesType
typedef Connection < targetidentifierT >	ConnectionBase

Public Member Functions
	StaticConnection ()
	Default Constructor. More...
	StaticConnection (const StaticConnection &rhs)
	Copy constructor from a property object. More...
void	check_connection (Node &s, Node &t, rport receptor_type, double_t, const CommonPropertiesType &)
void	send (Event &e, thread t, double_t, const CommonSynapseProperties &)
void	get_status (DictionaryDatum &d) const
void	set_status (const DictionaryDatum &d, ConnectorModel &cm)
void	set_weight (double_t w)
Public Member Functions inherited from nest::Connection< targetidentifierT >
	Connection ()
	Connection (const Connection< targetidentifierT > &rhs)
void	get_status (DictionaryDatum &d) const
	Get all properties of this connection and put them into a dictionary. More...
void	set_status (const DictionaryDatum &d, ConnectorModel &cm)
	Set properties of this connection from the values given in dictionary. More...
void	calibrate (const TimeConverter &)
	Calibrate the delay of this connection to the desired resolution. More...
double_t	get_delay () const
	Return the delay of the connection in ms. More...
long_t	get_delay_steps () const
	Return the delay of the connection in steps. More...
void	set_delay (const double_t delay)
	Set the delay of the connection. More...
void	set_delay_steps (const long_t delay)
	Set the delay of the connection in steps. More...
void	set_syn_id (synindex syn_id)
	Set the synapse id of the connection. More...
synindex	get_syn_id () const
	Get the synapse id of the connection. More...
void	trigger_update_weight (const thread, const std::vector< spikecounter > &, const double_t, const CommonSynapseProperties &)
	triggers an update of a synaptic weight this function is needed for neuromodulated synaptic plasticity More...
Node *	get_target (thread t) const
rport	get_rport () const

Private Attributes
double_t	weight_

Additional Inherited Members
Protected Member Functions inherited from nest::Connection< targetidentifierT >
void	check_connection_ (Node &dummy_target, Node &source, Node &target, rport receptor_type)
	This function calls check_connection() on the sender to check if the receiver accepts the event type and receptor type requested by the sender. More...
Protected Attributes inherited from nest::Connection< targetidentifierT >
targetidentifierT	target_
SynIdDelay	syn_id_delay_
	syn_id (char) and delay (24 bit) in timesteps of this connection More...

Detailed Description

template<typename targetidentifierT>
class nest::StaticConnection< targetidentifierT >

Class representing a static connection.

A static connection has the properties weight, delay and receiver port. A suitable Connector containing these connections can be obtained from the template GenericConnector.

Member Typedef Documentation

template<typename targetidentifierT >

typedef CommonSynapseProperties nest::StaticConnection< targetidentifierT >::CommonPropertiesType

template<typename targetidentifierT >

typedef Connection<targetidentifierT> nest::StaticConnection< targetidentifierT >::ConnectionBase

Constructor & Destructor Documentation

template<typename targetidentifierT >

nest::StaticConnection< targetidentifierT >::StaticConnection ( )

inline

Default Constructor.

Sets default values for all parameters. Needed by GenericConnectorModel.

template<typename targetidentifierT >

nest::StaticConnection< targetidentifierT >::StaticConnection ( const StaticConnection< targetidentifierT > &  rhs )

inline

Copy constructor from a property object.

Needs to be defined properly in order for GenericConnector to work.

Member Function Documentation

template<typename targetidentifierT >

void nest::StaticConnection< targetidentifierT >::check_connection ( Node &  s, Node &  t, rport  receptor_type, double_t  , const CommonPropertiesType &    )

inline

References nest::Connection< targetidentifierT >::check_connection_().

template<typename targetidentifierT >

void nest::StaticConnection< targetidentifierT >::get_status

(

DictionaryDatum &

d

)

const

References nest::names::d, nest::names::size_of, and nest::names::weight.

template<typename targetidentifierT >

void nest::StaticConnection< targetidentifierT >::send ( Event &  e, thread  t, double_t  , const CommonSynapseProperties &    )

inline

References numerics::e, nest::Connection< targetidentifierT >::get_delay_steps(), nest::Connection< targetidentifierT >::get_rport(), nest::Connection< targetidentifierT >::get_target(), nest::Event::set_delay(), nest::Event::set_receiver(), nest::Event::set_rport(), nest::Event::set_weight(), and nest::StaticConnection< targetidentifierT >::weight_.

template<typename targetidentifierT >

void nest::StaticConnection< targetidentifierT >::set_status	(	const DictionaryDatum &	d,
		ConnectorModel &	cm
	)

References nest::names::d, and nest::names::weight.

template<typename targetidentifierT >

void nest::StaticConnection< targetidentifierT >::set_weight ( double_t  w )

inline

References nest::names::w, and nest::StaticConnection< targetidentifierT >::weight_.

Member Data Documentation

template<typename targetidentifierT >

double_t nest::StaticConnection< targetidentifierT >::weight_

private

Referenced by nest::StaticConnection< targetidentifierT >::send(), and nest::StaticConnection< targetidentifierT >::set_weight().

---

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

• static_connection.h