flush_event_mechanism.h

Go to the documentation of this file.

/*
 *  flush_event_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 FLUSH_EVENT_MECHANISM_H
#define FLUSH_EVENT_MECHANISM_H
 
// nestkernel
#include "nest_time.h"
 
// libnestutil
#include "dict_util.h"
 
namespace nest
{
class FlushEventMechanism
{
public:
  FlushEventMechanism();
 
  FlushEventMechanism( const FlushEventMechanism& n );
 
  virtual ~FlushEventMechanism() = default;
 
  void
  set_last_event_time( const long last_event_time )
  {
    last_event_time_ = last_event_time;
  }
 
  long
  get_last_event_time() const
  {
    return last_event_time_;
  }
 
  void pre_run_hook();
 
  inline bool
  flush_event_is_due( const long current_time ) const
  {
    return last_event_time_ > 0 and ( current_time - last_event_time_ >= flush_event_send_interval_steps_ );
  }
 
  void get_status( Dictionary& d ) const;
 
  void set_status( const Dictionary& d, Node* node, const bool check_eprop_constraint = false );
 
protected:
  double flush_event_send_interval_;
 
  long flush_event_send_interval_steps_;
 
  long last_event_time_;
};
 
}  // namespace nest
 
#endif  // FLUSH_EVENT_MECHANISM_H