volume transmitter class. More...

#include <volume_transmitter.h>

Inheritance diagram for nest::volume_transmitter:

Classes
struct	Buffers_

struct	Parameters_
	Independent parameters of the model. More...

Public Member Functions
	volume_transmitter ()

	volume_transmitter (const volume_transmitter &)

bool	has_proxies () const
	Returns true if the node has proxies on remote threads. More...

bool	local_receiver () const
	Returns true if the node only receives events from nodes/devices on the same thread. More...

void	handle (SpikeEvent &)
	Handle incoming spike events. More...

port	handles_test_event (SpikeEvent &, rport)
	Check if the node can handle a particular event and receptor type. More...

void	get_status (DictionaryDatum &d) const

void	set_status (const DictionaryDatum &d)

const vector< spikecounter > &	deliver_spikes ()

Public Member Functions inherited from nest::Archiving_Node
	Archiving_Node ()
	Constructor. More...

	Archiving_Node (const Archiving_Node &)

double_t	get_K_value (double_t t)
	return the Kminus value at t (in ms). More...

void	get_K_values (double_t t, double_t &Kminus, double_t &triplet_Kminus)
	write the Kminus and triplet_Kminus values at t (in ms) to the provided locations. More...

double_t	get_triplet_K_value (const std::deque< histentry >::iterator &iter)
	return the triplet Kminus value for the associated iterator. More...

void	get_history (double_t t1, double_t t2, std::deque< histentry >::iterator start, std::deque< histentry >::iterator finish)
	return the spike times (in steps) of spikes which occurred in the range (t1,t2]. More...

void	register_stdp_connection (double_t t_first_read)
	Register a new incoming STDP connection. More...

void	unregister_stdp_connection (double_t t_last_read)
	Unregister this incoming connection. More...

void	get_status (DictionaryDatum &d) const

void	set_status (const DictionaryDatum &d)

Public Member Functions inherited from nest::Node
	Node ()

	Node (Node const &)

virtual	~Node ()

virtual Node *	clone () const
	Virtual copy constructor. More...

virtual bool	potential_global_receiver () const
	Returns true for potential global receivers (e.g. More...

virtual void	set_has_proxies (const bool)
	Sets has_proxies_ member variable (to switch to global spike detection mode) More...

virtual void	set_local_receiver (const bool)
	Sets local_receiver_ member variable (to switch to global spike detection mode) More...

virtual bool	one_node_per_process () const
	Returns true if the node exists only once per process, but does not have proxies on remote threads. More...

virtual bool	is_off_grid () const
	Returns true if the node if it sends/receives -grid events This is used to discriminate between different types of nodes, when adding new nodes to the network. More...

virtual bool	is_proxy () const
	Returns true if the node is a proxy node. More...

std::string	get_name () const
	Return class name. More...

index	get_gid () const
	Return global Network ID. More...

index	get_lid () const
	Return local node ID. More...

index	get_subnet_index () const
	Return the index to the node in the node array of the parent subnet. More...

int	get_model_id () const
	Return model ID of the node. More...

Subnet *	get_parent () const
	Return pointer to parent subnet. More...

virtual std::string	print_network (int, int, std::string="")
	Prints out one line of the tree view of the network. More...

bool	is_frozen () const
	Returns true if node is frozen, i.e., shall not be updated. More...

bool	is_local () const
	Returns true if the node is allocated in the local process. More...

void	init_state ()
	Set state variables to the default values for the model. More...

void	init_buffers ()
	Initialize buffers of a node. More...

virtual void	finalize ()
	Finalize node. More...

virtual void	set_status (const DictionaryDatum &)=0
	Change properties of the node according to the entries in the dictionary. More...

virtual void	get_status (DictionaryDatum &) const =0
	Export properties of the node by setting entries in the status dictionary. More...

virtual port	send_test_event (Node &receiving_node, rport receptor_type, synindex syn_id, bool dummy_target)
	Send an event to the receiving_node passed as an argument. More...

virtual port	handles_test_event (RateEvent &, rport receptor_type)

virtual port	handles_test_event (DataLoggingRequest &, rport receptor_type)

virtual port	handles_test_event (CurrentEvent &, rport receptor_type)

virtual port	handles_test_event (ConductanceEvent &, rport receptor_type)

virtual port	handles_test_event (DoubleDataEvent &, rport receptor_type)

virtual port	handles_test_event (DSSpikeEvent &, rport receptor_type)

virtual port	handles_test_event (DSCurrentEvent &, rport receptor_type)

virtual void	handle (RateEvent &e)
	Handler for rate events. More...

virtual void	handle (DataLoggingRequest &e)
	Handler for universal data logging request. More...

virtual void	handle (DataLoggingReply &e)
	Handler for universal data logging request. More...

virtual void	handle (CurrentEvent &e)
	Handler for current events. More...

virtual void	handle (ConductanceEvent &e)
	Handler for conductance events. More...

virtual void	handle (DoubleDataEvent &e)
	Handler for DoubleData events. More...

virtual void	event_hook (DSSpikeEvent &)
	Modify Event object parameters during event delivery. More...

virtual void	event_hook (DSCurrentEvent &)

void	set_thread (thread)
	Store the number of the thread to which the node is assigned. More...

thread	get_thread () const
	Retrieve the number of the thread to which the node is assigned. More...

void	set_vp (thread)
	Store the number of the virtual process to which the node is assigned. More...

thread	get_vp () const
	Retrieve the number of the virtual process to which the node is assigned. More...

void	set_model_id (int)
	Set the model id. More...

virtual bool	is_subnet () const

DictionaryDatum	get_status_base ()
	Return a dictionary with the node's properties. More...

void	set_status_base (const DictionaryDatum &)
	Set status dictionary of a node. More...

bool	is_model_prototype () const
	Returns true if node is model prototype. More...

void	set_thread_lid (const index)
	set thread local index More...

index	get_thread_lid () const
	get thread local index More...

bool	buffers_initialized () const
	True if buffers have been initialized. More...

void	set_buffers_initialized (bool initialized)

Private Member Functions
void	init_state_ (Node const &)
	Private function to initialize the state of a node to model defaults. More...

void	init_buffers_ ()
	Private function to initialize the buffers of a node. More...

void	calibrate ()
	Re-calculate dependent parameters of the node. More...

void	update (const Time &, const long_t, const long_t)
	Bring the node from state $t$ to $t+n*dt$. More...

Private Attributes
Parameters_	P_

Buffers_	B_

Additional Inherited Members
Static Public Member Functions inherited from nest::Node
static Network *	network ()
	Return pointer to network driver class. More...

Protected Member Functions inherited from nest::Archiving_Node
void	set_spiketime (Time const &t_sp)
	record spike history More...

double_t	get_spiketime_ms () const

void	clear_history ()
	clear spike history More...

Protected Member Functions inherited from nest::Node
virtual size_t	num_thread_siblings_ () const
	Return the number of thread siblings in SiblingContainer. More...

virtual Node *	get_thread_sibling_ (index) const
	Return the specified member of a SiblingContainer. More...

virtual Node *	get_thread_sibling_safe_ (index) const
	Return specified member of a SiblingContainer, with access control. More...

Model &	get_model_ () const

void	set_frozen_ (bool frozen)
	Mark node as frozen. More...

template<typename ConcreteNode >
const ConcreteNode &	downcast (const Node &)
	Auxiliary function to downcast a Node to a concrete class derived from Node. More...

Static Protected Attributes inherited from nest::Node
static Network *	net_ =NULL
	Pointer to global network driver. More...

Detailed Description

volume transmitter class.

This class manages spike recording for normal and precise spikes. It receives spikes via its handle(SpikeEvent&) method and buffers them. In the update() method it stores the newly collected buffer elements, which are delivered in time steps of (d_min*deliver_interval) to the neuromodulated synapses. In addition the synapses can ask the volume transmitter to deliver the elements stored in the update() method with the method deliver_spikes().

Constructor & Destructor Documentation

nest::volume_transmitter::volume_transmitter ( )

nest::volume_transmitter::volume_transmitter ( const volume_transmitter & n )

Member Function Documentation

void nest::volume_transmitter::calibrate ( )

privatevirtual

Re-calculate dependent parameters of the node.

This function is called each time a simulation is begun/resumed. It must re-calculate all internal Variables of the node required for spike handling or updating the node.

Implements nest::Node.

References nest::Scheduler::get_min_delay().

const vector< nest::spikecounter > & nest::volume_transmitter::deliver_spikes ( )

inline

References B_, and nest::volume_transmitter::Buffers_::spikecounter_.

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

void nest::volume_transmitter::get_status ( DictionaryDatum & d ) const

inline

References nest::names::element_type, nest::volume_transmitter::Parameters_::get(), nest::Archiving_Node::get_status(), nest::names::other, and P_.

void nest::volume_transmitter::handle ( SpikeEvent & e )

virtual

Handle incoming spike events.

Default implementation of event handlers just throws an UnexpectedEvent exception.

Parameters

thrd	Id of the calling thread.
e	Event object.

This handler has to be implemented if a Node should accept spike events.

See also: class SpikeEvent; class UnexpectedEvent

Exceptions

UnexpectedEvent This is the default event to throw.

Reimplemented from nest::Node.

References nest::SpikeEvent::get_multiplicity(), and nest::Event::get_rel_delivery_steps().

port nest::volume_transmitter::handles_test_event	(	SpikeEvent &	,
		rport	receptor_type
	)

inlinevirtual

Check if the node can handle a particular event and receptor type.

This function is called upon connection setup by send_test_event().

handles_test_event() function is used to verify that the receiver can handle the event. It can also be used by the receiver to return information to the sender in form of the returned port. The default implementation throws an IllegalConnection exception. Any node class should define handles_test_event() functions for all those event types it can handle.

See Kunkel et al, Front Neuroinform 8:78 (2014), Sec 3.

Note: The semantics of all other handles_test_event() functions is identical.

Exceptions

IllegalConnection

Reimplemented from nest::Node.

References nest::Node::get_name().

bool nest::volume_transmitter::has_proxies ( ) const

inlinevirtual

Returns true if the node has proxies on remote threads.

This is used to discriminate between different types of nodes, when adding new nodes to the network.

Reimplemented from nest::Node.

void nest::volume_transmitter::init_buffers_ ( )

privatevirtual

Private function to initialize the buffers of a node.

This function, which must be overloaded by all derived classes, provides the implementation for initializing the buffers of a node.

See also: Node::init_buffers()

Implements nest::Node.

References nest::Archiving_Node::clear_history().

void nest::volume_transmitter::init_state_ ( Node const & )

privatevirtual

Private function to initialize the state of a node to model defaults.

This function, which must be overloaded by all derived classes, provides the implementation for initializing the state of a node to the model defaults; the state is the set of observable dynamic variables.

Parameters

Reference to model prototype object.

See also: Node::init_state()

Note: To provide a reasonable behavior during the transition to the new scheme, init_state_() has a default implementation calling init_dynamic_state_().

Implements nest::Node.

bool nest::volume_transmitter::local_receiver ( ) const

inlinevirtual

Returns true if the node only receives events from nodes/devices on the same thread.

Reimplemented from nest::Node.

void nest::volume_transmitter::set_status ( const DictionaryDatum & d )

inline

References P_, nest::volume_transmitter::Parameters_::set(), and nest::Archiving_Node::set_status().

void nest::volume_transmitter::update	(	const Time &	,
		const long_t	,
		const long_t
	)

privatevirtual

Bring the node from state $t$ to $t+n*dt$.

n->update(T, from, to) performs the update steps beginning at T+from .. T+to-1, ie, emitting events with time stamps T+from+1 .. T+to.

Parameters

Time	network time at beginning of time slice.
long_t	initial step inside time slice
long_t	post-final step inside time slice

Implements nest::Node.

References nest::Scheduler::get_min_delay(), nest::Time::get_ms(), and nest::names::t_spike.

Member Data Documentation

Buffers_ nest::volume_transmitter::B_

private

Referenced by deliver_spikes().

Parameters_ nest::volume_transmitter::P_

private

Referenced by get_status(), and set_status().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation