nest::DiffusionConnectionEvent Class Reference

Event for diffusion connections (rate model connections for the siegert_neuron). More...

#include <secondary_event.h>

Inheritance diagram for nest::DiffusionConnectionEvent:

Collaboration diagram for nest::DiffusionConnectionEvent:

Public Member Functions
	DiffusionConnectionEvent ()
void	operator() () override
	Deliver the event to receiver.
DiffusionConnectionEvent *	clone () const override
void	set_diffusion_factor (double t) override
	Set diffusion_factor of the event (see DiffusionConnectionEvent).
void	set_drift_factor (double t) override
	Set drift_factor of the event (see DiffusionConnectionEvent).
double	get_drift_factor () const
double	get_diffusion_factor () const
Public Member Functions inherited from nest::DataSecondaryEvent< double, DiffusionConnectionEvent >
void	add_syn_id (const synindex synid) override
	This function adds the ids of connection models that use this event type.
const std::set< synindex > &	get_supported_syn_ids () const override
void	reset_supported_syn_ids () override
	Resets the vector of supported syn ids to those originally registered via ModelsModule or user defined Modules, i.e., removes all syn ids created by CopyModel.
void	set_coeffarray (std::vector< double > &ca)
std::vector< unsignedint >::iterator &	operator<< (std::vector< unsigned int >::iterator &pos) override
	The following operator is used to read the information of the DataSecondaryEvent from the buffer in EventDeliveryManager::deliver_events.
std::vector< unsignedint >::iterator &	operator>> (std::vector< unsigned int >::iterator &pos) override
	The following operator is used to write the information of the DataSecondaryEvent into the secondary_events_buffer_.
size_t	size () override
	size of event in units of unsigned int
const std::vector< unsignedint >::iterator &	begin ()
const std::vector< unsignedint >::iterator &	end ()
double	get_coeffvalue (std::vector< unsigned int >::iterator &pos)
Public Member Functions inherited from nest::Event
	Event ()
virtual	~Event ()
void	set_receiver (Node &)
	Change pointer to receiving Node.
Node &	get_receiver () const
	Return reference to receiving Node.
size_t	get_receiver_node_id () const
	Return node ID of receiving Node.
Node &	get_sender () const
	Return reference to sending Node.
void	set_sender (Node &)
	Change pointer to sending Node.
size_t	get_sender_node_id () const
	Sender is local.
size_t	retrieve_sender_node_id_from_source_table () const
	Sender is not local.
void	set_sender_node_id (const size_t)
	Change node ID of sending Node.
void	set_sender_node_id_info (const size_t tid, const synindex syn_id, const size_t lcid)
	Set tid, syn_id, lcid of spike_data_.
Time const &	get_stamp () const
	Return time stamp of the event.
void	set_delay_steps (long)
	Set the transmission delay of the event.
long	get_delay_steps () const
	Return transmission delay of the event.
long	get_rel_delivery_steps (const Time &t) const
	Relative spike delivery time in steps.
size_t	get_port () const
	Return the sender port number of the event.
size_t	get_rport () const
	Return the receiver port number of the event.
void	set_port (size_t p)
	Set the port number.
void	set_rport (size_t p)
	Set the receiver port number (r-port).
double	get_offset () const
	Return the creation time offset of the Event.
void	set_offset (double t)
	Set the creation time of the Event.
double	get_weight () const
	Return the weight.
void	set_weight (double t)
	Set weight of the event.
bool	sender_is_valid () const
	Returns true if the pointer to the sender node is valid.
bool	receiver_is_valid () const
	Returns true if the pointer to the receiver node is valid.
bool	is_valid () const
	Check integrity of the event.
void	set_stamp (Time const &)
	Set the time stamp of the event.
void	set_flush_event_flag (bool is_flush_event)
	Sets the flush event flag.
bool	is_flush_event ()
	Returns whether this spike is a flush event.

Private Attributes
double	drift_factor_
double	diffusion_factor_

Additional Inherited Members
Static Public Member Functions inherited from nest::DataSecondaryEvent< double, DiffusionConnectionEvent >
static void	set_coeff_length (const size_t coeff_length)
Protected Attributes inherited from nest::Event
size_t	sender_node_id_
	node ID of sender or 0
SpikeData	sender_spike_data_
	spike data of sender node, in some cases required to retrieve node ID
Node *	sender_
	Pointer to sender or nullptr.
Node *	receiver_
	Pointer to receiver or nullptr.
size_t	p_
	Sender port number.
size_t	rp_
	Receiver port number (r-port).
long	d_
	Transmission delay.
Time	stamp_
	Time stamp.
long	stamp_steps_
	Time stamp in steps.
double	offset_
	Offset for precise spike times.
double	w_
	Weight of the connection.

Detailed Description

Event for diffusion connections (rate model connections for the siegert_neuron).

The event transmits the rate to the connected neurons.

Constructor & Destructor Documentation

DiffusionConnectionEvent()

nest::DiffusionConnectionEvent::DiffusionConnectionEvent ( )

inline

Referenced by clone().

Here is the caller graph for this function:

Member Function Documentation

clone()

DiffusionConnectionEvent * nest::DiffusionConnectionEvent::clone ( ) const

inlineoverridevirtual

Implements nest::SecondaryEvent.

References DiffusionConnectionEvent().

Here is the call graph for this function:

get_diffusion_factor()

double nest::DiffusionConnectionEvent::get_diffusion_factor ( ) const

inline

References diffusion_factor_.

get_drift_factor()

double nest::DiffusionConnectionEvent::get_drift_factor ( ) const

inline

References drift_factor_.

operator()()

void nest::DiffusionConnectionEvent::operator() ( )

overridevirtual

Deliver the event to receiver.

This operator calls the handler for the specific event type at the receiver.

Implements nest::Event.

References nest::Node::handle(), and nest::Event::receiver_.

Here is the call graph for this function:

set_diffusion_factor()

void nest::DiffusionConnectionEvent::set_diffusion_factor ( double  )

inlineoverridevirtual

Set diffusion_factor of the event (see DiffusionConnectionEvent).

Reimplemented from nest::Event.

References diffusion_factor_.

set_drift_factor()

void nest::DiffusionConnectionEvent::set_drift_factor ( double  )

inlineoverridevirtual

Set drift_factor of the event (see DiffusionConnectionEvent).

Reimplemented from nest::Event.

References drift_factor_.

Member Data Documentation

diffusion_factor_

double nest::DiffusionConnectionEvent::diffusion_factor_

private

Referenced by get_diffusion_factor(), and set_diffusion_factor().

drift_factor_

double nest::DiffusionConnectionEvent::drift_factor_

private

Referenced by get_drift_factor(), and set_drift_factor().

---

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

• secondary_event.h
• event.cpp