recording_backend.h

Go to the documentation of this file.

/*
 *  recording_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 RECORDING_BACKEND_H
#define RECORDING_BACKEND_H
 
// C++ includes:
#include <vector>
 
#include "dictionary.h"
 
namespace nest
{
 
class RecordingDevice;
class Event;
 
class RecordingBackend
{
public:
  RecordingBackend()
  {
  }
 
  virtual ~RecordingBackend() throw()
  {
  }
 
  virtual void initialize() = 0;
  virtual void finalize() = 0;
 
  virtual void enroll( const RecordingDevice& device, const Dictionary& params ) = 0;
 
  virtual void disenroll( const RecordingDevice& device ) = 0;
 
  virtual void set_value_names( const RecordingDevice& device,
    const std::vector< std::string >& double_value_names,
    const std::vector< std::string >& long_value_names ) = 0;
 
  virtual void prepare() = 0;
 
  virtual void cleanup() = 0;
 
  virtual void pre_run_hook() = 0;
 
  virtual void post_run_hook() = 0;
 
  virtual void post_step_hook() = 0;
 
  virtual void write( const RecordingDevice& device,
    const Event& event,
    const std::vector< double >& double_values,
    const std::vector< long >& long_values ) = 0;
 
  virtual void set_status( const Dictionary& params ) = 0;
 
  virtual void get_status( Dictionary& params ) const = 0;
 
  virtual void check_device_status( const Dictionary& params ) const = 0;
 
  virtual void get_device_defaults( Dictionary& params ) const = 0;
 
  virtual void get_device_status( const RecordingDevice& device, Dictionary& params ) const = 0;
 
  static const std::vector< std::string > NO_DOUBLE_VALUE_NAMES;
  static const std::vector< std::string > NO_LONG_VALUE_NAMES;
  static const std::vector< double > NO_DOUBLE_VALUES;
  static const std::vector< long > NO_LONG_VALUES;
};
 
}  // namespace
 
#endif /* #ifndef RECORDING_BACKEND_H */