#include <sic_connection.h>

Inheritance diagram for nest::sic_connection< targetidentifierT >:

Collaboration diagram for nest::sic_connection< targetidentifierT >:

Public Types
typedef CommonSynapseProperties	CommonPropertiesType

typedef Connection< targetidentifierT >	ConnectionBase

typedef SICEvent	EventType

Public Member Functions
	sic_connection ()
	Default Constructor.

std::unique_ptr< SecondaryEvent >	get_secondary_event ()

void	check_connection (Node &s, Node &t, size_t receptor_type, const CommonPropertiesType &)

bool	send (Event &e, size_t t, const CommonSynapseProperties &)
	Send an event to the receiver of this connection.

void	get_status (Dictionary &d) const

void	set_status (const Dictionary &d, ConnectorModel &cm)

void	set_weight (double w)

long	get_delay_steps () const
	Return the delay of the connection in steps.

size_t	get_rport () const

Node *	get_target (const size_t tid) const

Public Member Functions inherited from nest::Connection< targetidentifierT >
	Connection ()

	Connection (const Connection< targetidentifierT > &rhs)=default

Connection &	operator= (const Connection< targetidentifierT > &rhs)=default

std::unique_ptr< SecondaryEvent >	get_secondary_event ()
	Get a pointer to an instance of a SecondaryEvent if this connection supports secondary events.

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.

void	check_synapse_params (const Dictionary &d) const
	Check syn_spec dictionary for parameters that are not allowed with the given connection.

void	calibrate (const TimeConverter &)
	Calibrate the delay of this connection to the desired resolution.

double	get_delay () const
	Return the delay of the connection in ms.

long	get_delay_steps () const
	Return the delay of the connection in steps.

void	set_delay (const double delay)
	Set the delay of the connection.

void	set_delay_steps (const long delay)
	Set the delay of the connection in steps.

void	set_syn_id (synindex syn_id)
	Set the synapse id of the connection.

synindex	get_syn_id () const
	Get the synapse id of the connection.

long	get_label () const

void	trigger_update_weight (const size_t, const std::vector< spikecounter > &, const double, const CommonSynapseProperties &)
	Triggers an update of a synaptic weight.

Node *	get_target (const size_t tid) const

size_t	get_rport () const

void	set_source_has_more_targets (const bool more_targets)
	Sets a flag in the connection to signal that the following connection has the same source.

bool	source_has_more_targets () const
	Returns a flag denoting whether the connection has source subsequent targets.

void	disable ()
	Disables the connection.

bool	is_disabled () const
	Returns a flag denoting if the connection is disabled.

Static Public Attributes
static constexpr ConnectionModelProperties	properties = ConnectionModelProperties::HAS_DELAY

Static Public Attributes inherited from nest::Connection< targetidentifierT >
static constexpr ConnectionModelProperties	properties = ConnectionModelProperties::NONE

static constexpr bool	supports_flush_event = false

Private Attributes
double	weight_
	connection weight

Additional Inherited Members
Protected Member Functions inherited from nest::Connection< targetidentifierT >
void	check_connection_ (Node &dummy_target, Node &source, Node &target, const size_t 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.

Protected Attributes inherited from nest::Connection< targetidentifierT >
targetidentifierT	target_

SynIdDelay	syn_id_delay_

Member Typedef Documentation

◆ CommonPropertiesType

template<typename targetidentifierT >

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

◆ ConnectionBase

template<typename targetidentifierT >

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

◆ EventType

template<typename targetidentifierT >

typedef SICEvent nest::sic_connection< targetidentifierT >::EventType

Constructor & Destructor Documentation

◆ sic_connection()

template<typename targetidentifierT >

nest::sic_connection< targetidentifierT >::sic_connection ( )

inline

Default Constructor.

Sets default values for all parameters. Needed by GenericConnectorModel.

Member Function Documentation

◆ check_connection()

template<typename targetidentifierT >

void nest::sic_connection< targetidentifierT >::check_connection	(	Node &	s,
		Node &	t,
		size_t	receptor_type,
		const CommonPropertiesType &
	)

inline

References nest::Node::handles_test_event(), nest::Node::sends_secondary_event(), and nest::Event::set_sender().

Here is the call graph for this function:

◆ get_delay_steps()

template<typename targetidentifierT >

long nest::Connection< targetidentifierT >::get_delay_steps ( ) const

inline

Return the delay of the connection in steps.

Referenced by nest::sic_connection< targetidentifierT >::send().

Here is the caller graph for this function:

◆ get_rport()

template<typename targetidentifierT >

size_t nest::Connection< targetidentifierT >::get_rport ( ) const

inline

Referenced by nest::sic_connection< targetidentifierT >::send().

Here is the caller graph for this function:

◆ get_secondary_event()

template<typename targetidentifierT >

std::unique_ptr< SecondaryEvent > nest::sic_connection< targetidentifierT >::get_secondary_event ( )

◆ get_status()

template<typename targetidentifierT >

void nest::sic_connection< targetidentifierT >::get_status ( Dictionary & d ) const

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

Here is the call graph for this function:

◆ get_target()

template<typename targetidentifierT >

Node * nest::Connection< targetidentifierT >::get_target ( const size_t tid ) const

inline

Referenced by nest::sic_connection< targetidentifierT >::send().

Here is the caller graph for this function:

◆ send()

template<typename targetidentifierT >

bool nest::sic_connection< targetidentifierT >::send	(	Event &	e,
		size_t	t,
		const CommonSynapseProperties &
	)

inline

Send an event to the receiver of this connection.

Parameters

e	The event to send
p	The port under which this connection is stored in the Connector.

References nest::sic_connection< targetidentifierT >::get_delay_steps(), nest::sic_connection< targetidentifierT >::get_rport(), nest::sic_connection< targetidentifierT >::get_target(), and nest::sic_connection< targetidentifierT >::weight_.

Here is the call graph for this function:

◆ set_status()

template<typename targetidentifierT >

void nest::sic_connection< targetidentifierT >::set_status	(	const Dictionary &	d,
		ConnectorModel &	cm
	)

References nest::names::weight().

Here is the call graph for this function:

◆ set_weight()

template<typename targetidentifierT >

void nest::sic_connection< targetidentifierT >::set_weight ( double w )

inline

References nest::sic_connection< targetidentifierT >::weight_.

Member Data Documentation

◆ properties

template<typename targetidentifierT >

constexpr ConnectionModelProperties nest::sic_connection< targetidentifierT >::properties = ConnectionModelProperties::HAS_DELAY

staticconstexpr

◆ weight_

template<typename targetidentifierT >

double nest::sic_connection< targetidentifierT >::weight_

private

connection weight

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

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

sic_connection.h

	NEST main@caf0ae8

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CommonPropertiesType

◆ ConnectionBase

◆ EventType

Constructor & Destructor Documentation

◆ sic_connection()

Member Function Documentation

◆ check_connection()

◆ get_delay_steps()

◆ get_rport()

◆ get_secondary_event()

◆ get_status()

◆ get_target()

◆ send()

◆ set_status()

◆ set_weight()

Member Data Documentation

◆ properties

◆ weight_