static_connection_hom_w.h

Go to the documentation of this file.

/*
 *  static_connection_hom_w.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/>.
 *
 */


/* BeginDocumentation
   Name: static_synapse_hom_w - Synapse type for static connections with homogeneous weight.
   
   Description:
     static_synapse_hom_w does not support any kind of plasticity. It simply stores
     the parameters target, and receiver port for each connection and uses a common 
     weight and delay for all connections.

   Transmits: SpikeEvent, RateEvent, CurrentEvent, ConductanceEvent, DataLoggingRequest, DoubleDataEvent

   Parameters:
     No Parameters

   References:
     No References
   FirstVersion: April 2008
   Author: Susanne Kunkel, Moritz Helias
   SeeAlso: synapsedict, static_synapse
*/

#ifndef STATICCONNECTION_HOM_W_H
#define STATICCONNECTION_HOM_W_H

#include "connection.h"
#include "common_properties_hom_w.h"

namespace nest
{

template<typename targetidentifierT>
class StaticConnectionHomW : public Connection<targetidentifierT>
{

 public:

  // this line determines which common properties to use
  typedef CommonPropertiesHomW CommonPropertiesType;
  typedef Connection<targetidentifierT> ConnectionBase;

  // Explicitly declare all methods inherited from the dependent base ConnectionBase.
  // This avoids explicit name prefixes in all places these functions are used.
  // Since ConnectionBase depends on the template parameter, they are not automatically
  // found in the base class.
  using ConnectionBase::get_rport;
  using ConnectionBase::get_target;
  using ConnectionBase::get_delay_steps;

  class ConnTestDummyNode: public ConnTestDummyNodeBase
  {
  public:
    // Ensure proper overriding of overloaded virtual functions.
    // Return values from functions are ignored.
    using ConnTestDummyNodeBase::handles_test_event;
    port handles_test_event(SpikeEvent&, rport) { return invalid_port_; }
    port handles_test_event(RateEvent&, rport) { return invalid_port_; }
    port handles_test_event(DataLoggingRequest&, rport) { return invalid_port_; }
    port handles_test_event(CurrentEvent&, rport) { return invalid_port_; }
    port handles_test_event(ConductanceEvent&, rport) { return invalid_port_; }
    port handles_test_event(DoubleDataEvent&, rport) { return invalid_port_; }
    port handles_test_event(DSSpikeEvent&, rport) { return invalid_port_; }
    port handles_test_event(DSCurrentEvent&, rport) { return invalid_port_; }
  };

  
  void get_status(DictionaryDatum & d) const;

  void check_connection(Node & s, Node & t, rport receptor_type, double_t, const CommonPropertiesType &)
  {
    ConnTestDummyNode dummy_target;
    ConnectionBase::check_connection_(dummy_target, s, t, receptor_type);
  }

  void send(Event& e, thread t, double_t, const CommonPropertiesHomW &cp)
  {
    e.set_weight(cp.get_weight());
    e.set_delay(get_delay_steps());
    e.set_receiver( *get_target(t) );
    e.set_rport( get_rport() );
    e();
  }

  void set_weight(double_t) { throw BadProperty("Setting of individual weights is not possible! The common weights can be changed via CopyModel()."); }

};


  template<typename targetidentifierT>
    void StaticConnectionHomW<targetidentifierT>::get_status(DictionaryDatum & d) const
    {
      ConnectionBase::get_status(d);
      def<long_t>(d, names::size_of, sizeof(*this));
    }

} // namespace

#endif /* #ifndef STATICCONNECTION_HOM_W_H */