NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
nest::Archiving_Node Class Reference

a node which archives spike history for the purposes of timing dependent plasticity More...

#include <archiving_node.h>

Inheritance diagram for nest::Archiving_Node:
nest::Node nest::aeif_cond_alpha nest::aeif_cond_alpha_multisynapse nest::aeif_cond_alpha_RK5 nest::aeif_cond_exp nest::amat2_psc_exp nest::binary_neuron< TGainfunction > nest::hh_cond_exp_traub nest::hh_psc_alpha nest::ht_neuron nest::iaf_chs_2007 nest::iaf_chxk_2008 nest::iaf_cond_alpha nest::iaf_cond_alpha_mc nest::iaf_cond_exp nest::iaf_cond_exp_sfa_rr nest::iaf_neuron nest::iaf_psc_alpha nest::iaf_psc_alpha_multisynapse nest::iaf_psc_delta nest::iaf_psc_exp nest::iaf_psc_exp_multisynapse nest::iaf_tum_2000 nest::izhikevich nest::mat2_psc_exp nest::parrot_neuron nest::pp_pop_psc_delta nest::pp_psc_delta nest::relaxos_van_der_pol nest::sli_neuron nest::volume_transmitter

Public Member Functions

 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 Nodeclone () const
 Virtual copy constructor. More...
 
virtual bool has_proxies () const
 Returns true if the node has proxies on remote threads. 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 local_receiver () const
 Returns true if the node only receives events from nodes/devices on the same thread. 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...
 
Subnetget_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 calibrate ()=0
 Re-calculate dependent parameters of the node. More...
 
virtual void finalize ()
 Finalize node. More...
 
virtual void update (Time const &, const long_t, const long_t)=0
 Bring the node from state $t$ to $t+n*dt$. 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 (SpikeEvent &, rport receptor_type)
 Check if the node can handle a particular event and receptor type. 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 (SpikeEvent &e)
 Handle incoming spike events. More...
 
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)
 

Protected Member Functions

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 Nodeget_thread_sibling_ (index) const
 Return the specified member of a SiblingContainer. More...
 
virtual Nodeget_thread_sibling_safe_ (index) const
 Return specified member of a SiblingContainer, with access control. More...
 
virtual void init_state_ (Node const &)=0
 Private function to initialize the state of a node to model defaults. More...
 
virtual void init_buffers_ ()=0
 Private function to initialize the buffers of a node. More...
 
Modelget_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...
 

Private Attributes

size_t n_incoming_
 
double_t Kminus_
 
double_t triplet_Kminus_
 
double_t tau_minus_
 
double_t tau_minus_triplet_
 
double_t last_spike_
 
std::deque< histentryhistory_
 

Additional Inherited Members

- Static Public Member Functions inherited from nest::Node
static Networknetwork ()
 Return pointer to network driver class. More...
 
- Static Protected Attributes inherited from nest::Node
static Networknet_ =NULL
 Pointer to global network driver. More...
 

Detailed Description

a node which archives spike history for the purposes of timing dependent plasticity

Constructor & Destructor Documentation

nest::Archiving_Node::Archiving_Node ( )

Constructor.

Copy Constructor.

nest::Archiving_Node::Archiving_Node ( const Archiving_Node n)

Member Function Documentation

void nest::Archiving_Node::clear_history ( )
protected
void nest::Archiving_Node::get_history ( double_t  t1,
double_t  t2,
std::deque< histentry >::iterator *  start,
std::deque< histentry >::iterator *  finish 
)
virtual

return the spike times (in steps) of spikes which occurred in the range (t1,t2].

Reimplemented from nest::Node.

double_t nest::Archiving_Node::get_K_value ( double_t  t)
virtual

return the Kminus value at t (in ms).

Reimplemented from nest::Node.

void nest::Archiving_Node::get_K_values ( double_t  t,
double_t Kminus,
double_t triplet_Kminus 
)
virtual

write the Kminus and triplet_Kminus values at t (in ms) to the provided locations.

Exceptions
UnexpectedEvent

Reimplemented from nest::Node.

double_t nest::Archiving_Node::get_spiketime_ms ( ) const
inlineprotected
void nest::Archiving_Node::get_status ( DictionaryDatum d) const
double_t nest::Archiving_Node::get_triplet_K_value ( const std::deque< histentry >::iterator &  iter)

return the triplet Kminus value for the associated iterator.

void nest::Archiving_Node::register_stdp_connection ( double_t  t_first_read)
virtual

Register a new incoming STDP connection.

t_first_read: The newly registered synapse will read the history entries with t > t_first_read.

Reimplemented from nest::Node.

References history_, and n_incoming_.

void nest::Archiving_Node::set_spiketime ( Time const &  t_sp)
protected
void nest::Archiving_Node::set_status ( const DictionaryDatum d)
void nest::Archiving_Node::unregister_stdp_connection ( double_t  t_last_read)
virtual

Unregister this incoming connection.

t_last_read: The unregistered synapse has read all history entries with t <= t_last_read.

Reimplemented from nest::Node.

References history_, and n_incoming_.

Member Data Documentation

std::deque<histentry> nest::Archiving_Node::history_
private
double_t nest::Archiving_Node::Kminus_
private
double_t nest::Archiving_Node::last_spike_
private

Referenced by get_spiketime_ms().

size_t nest::Archiving_Node::n_incoming_
private
double_t nest::Archiving_Node::tau_minus_
private
double_t nest::Archiving_Node::tau_minus_triplet_
private
double_t nest::Archiving_Node::triplet_Kminus_
private

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