archiving_node.h

Go to the documentation of this file.

/*
 *  archiving_node.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ARCHIVING_NODE_H
#define ARCHIVING_NODE_H

#include "nest.h"
#include "node.h"
#include "dictdatum.h"
#include "nest_time.h"
#include "histentry.h"
#include <deque>

#define DEBUG_ARCHIVER 1

namespace nest {

  class Archiving_Node: 
    public Node 
{
   
 public:
  

  Archiving_Node();

  Archiving_Node(const Archiving_Node&);


  double_t get_K_value(double_t t);

  void get_K_values(double_t t, double_t& Kminus, double_t& triplet_Kminus); 

  double_t get_triplet_K_value(const std::deque<histentry>::iterator &iter);
  
  void get_history(double_t t1, double_t t2, 
                   std::deque<histentry>::iterator* start,
           std::deque<histentry>::iterator* finish);

  void register_stdp_connection(double_t t_first_read);

  void unregister_stdp_connection(double_t t_last_read);


  void get_status(DictionaryDatum & d) const;
  void set_status(const DictionaryDatum & d);

 protected:

  void set_spiketime(Time const & t_sp);

  inline double_t get_spiketime_ms() const;

  void clear_history();


 private:

  // number of incoming connections from stdp connectors.
  // needed to determine, if every incoming connection has
  // read the spikehistory for a given point in time
  size_t n_incoming_;

  // sum exp(-(t-ti)/tau_minus)
  double_t Kminus_;

  // sum exp(-(t-ti)/tau_minus_triplet)
  double_t triplet_Kminus_;

  double_t tau_minus_;

  // time constant for triplet low pass filtering of "post" spike train
  double_t tau_minus_triplet_;

  double_t last_spike_;

  // spiking history needed by stdp synapses
  std::deque<histentry> history_;

};
  
inline 
double_t Archiving_Node::get_spiketime_ms() const
{
   return last_spike_;
}

} // of namespace

#endif