ignore_and_spike_mechanism.h

Go to the documentation of this file.

/*
 *  ignore_and_spike_mechanism.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 IGNORE_AND_SPIKE_MECHANISM_H
#define IGNORE_AND_SPIKE_MECHANISM_H
 
// nestkernel
#include "nest_time.h"
 
// libnestutil
#include "dict_util.h"
 
namespace nest
{
class IgnoreAndSpikeMechanism
{
public:
  IgnoreAndSpikeMechanism();
 
  IgnoreAndSpikeMechanism( const IgnoreAndSpikeMechanism& n );
 
  virtual ~IgnoreAndSpikeMechanism() = default;
 
  inline bool
  spike_event_is_due( bool emit_dynamic_spike )
  {
    if ( ignore_and_spike_ )
    {
      --steps_until_spike_;
      const bool emit_forced_spike = steps_until_spike_ == 0;
      if ( emit_forced_spike )
      {
        steps_until_spike_ = interval_steps_;
      }
      return emit_forced_spike;
    }
    else
    {
      return emit_dynamic_spike;
    }
  }
 
  void get_status( Dictionary& d ) const;
 
  void set_status( const Dictionary& d, Node* node );
 
private:
  void initialize_offset();
 
  void initialize_interval();
 
  bool ignore_and_spike_;
 
  double offset_;
 
  double interval_;
 
  long interval_steps_;
 
  long steps_until_spike_;
};
 
}  // namespace nest
 
#endif  // IGNORE_AND_SPIKE_MECHANISM_H