Event for electrical currents. More...

#include <event.h>

Inheritance diagram for nest::CurrentEvent:

Collaboration diagram for nest::CurrentEvent:

Public Member Functions
void	operator() () override
	Deliver the event to receiver.

CurrentEvent *	clone () const override

void	set_current (double)

double	get_current () const

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.

virtual void	set_drift_factor (double)
	Set drift_factor of the event (see DiffusionConnectionEvent).

virtual void	set_diffusion_factor (double)
	Set diffusion_factor of the event (see DiffusionConnectionEvent).

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	c_

Additional Inherited Members
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 electrical currents.

Used to send currents from one node to the next.

Member Function Documentation

◆ clone()

CurrentEvent * nest::CurrentEvent::clone ( ) const

inlineoverridevirtual

Implements nest::Event.

◆ get_current()

double nest::CurrentEvent::get_current ( ) const

inline

References c_.

◆ operator()()

void nest::CurrentEvent::operator() ( )

overridevirtual

Deliver the event to receiver.

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

Implements nest::Event.

Reimplemented in nest::DSCurrentEvent.

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

Here is the call graph for this function:

◆ set_current()

void nest::CurrentEvent::set_current ( double c )

inline

References c_.

Referenced by nest::ac_generator::update(), nest::dc_generator::update(), and nest::step_current_generator::update().

Here is the caller graph for this function:

Member Data Documentation

◆ c_

double nest::CurrentEvent::c_

private

Referenced by get_current(), and set_current().

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

	NEST main@caf0ae8

Public Member Functions

Private Attributes

Additional Inherited Members