stimulation_backend.h

Go to the documentation of this file.

/*
 *  stimulation_backend.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 STIMULATION_BACKEND_H
#define STIMULATION_BACKEND_H
 
// C++ includes:
#include <vector>
 
#include "stimulation_device.h"
 
namespace nest
{
 
class StimulationBackend
{
public:
  StimulationBackend() = default;
 
  virtual ~StimulationBackend() noexcept = default;
 
  virtual void enroll( StimulationDevice&, const Dictionary& ) {};
 
  virtual void disenroll( StimulationDevice& ) {};
 
  virtual void pre_run_hook() = 0;
 
  virtual void post_run_hook() = 0;
 
  // In order to allow a derived backend do work at the end of each simulation step, this base
  // class could define the function post_step_hook() right about here.
  // However, this function would be called at the very end of each simulation step and require
  // a very tight synchronization between incoming data and the simulation control itself. As the
  // requirements for this are currently not formally defined due to the lack of a suitable use-case,
  // we decided to omit the function from the interface until such a use-case arises.
  virtual void initialize() = 0;
  virtual void finalize() = 0;
 
  virtual void prepare() = 0;
 
  virtual void cleanup() = 0;
 
  void clear( const StimulationDevice& ) {};
};
 
}  // namespace
 
#endif /* #ifndef STIMULATION_BACKEND_H */