io_manager.h

Go to the documentation of this file.

/*
 *  io_manager.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 IO_MANAGER_H
#define IO_MANAGER_H
 
// C++ includes:
#include <string>
 
// Includes from libnestutil:
#include "manager_interface.h"
 
#include "recording_backend.h"
#include "stimulation_backend.h"
 
namespace nest
{
 
class IOManager : public ManagerInterface
{
public:
  IOManager();
  ~IOManager() override;
 
  void initialize( const bool ) override;
  void finalize( const bool ) override;
  void set_status( const Dictionary& ) override;
  void get_status( Dictionary& ) override;
 
  void set_recording_backend_status( std::string, const Dictionary& );
  Dictionary get_recording_backend_status( std::string );
 
  const std::string& get_data_prefix() const;
 
  const std::string& get_data_path() const;
 
  bool overwrite_files() const;
 
  void post_run_hook();
  void pre_run_hook();
 
  void post_step_hook();
 
  void cleanup() override;
  void prepare() override;
 
  template < class RecordingBackendT >
  void register_recording_backend( const std::string& );
  template < class StimulationBackendT >
  void register_stimulation_backend( const std::string& );
 
  bool is_valid_recording_backend( const std::string& ) const;
  bool is_valid_stimulation_backend( const std::string& ) const;
 
  void write( const std::string&,
    const RecordingDevice&,
    const Event&,
    const std::vector< double >&,
    const std::vector< long >& );
 
  void enroll_recorder( const std::string&, const RecordingDevice&, const Dictionary& );
  void enroll_stimulator( const std::string&, StimulationDevice&, const Dictionary& );
 
  void set_recording_value_names( const std::string& backend_name,
    const RecordingDevice& device,
    const std::vector< std::string >& double_value_names,
    const std::vector< std::string >& long_value_names );
 
  void check_recording_backend_device_status( const std::string&, const Dictionary& );
  void get_recording_backend_device_defaults( const std::string&, Dictionary& );
  void get_recording_backend_device_status( const std::string&, const RecordingDevice&, Dictionary& );
 
private:
  void set_data_path_prefix_( const Dictionary& );
 
  std::string data_path_;    
  std::string data_prefix_;  
  bool overwrite_files_;     
 
  std::map< std::string, RecordingBackend* > recording_backends_;
 
  std::map< std::string, StimulationBackend* > stimulation_backends_;
};
 
inline const std::string&
IOManager::get_data_path() const
{
  return data_path_;
}
 
inline const std::string&
IOManager::get_data_prefix() const
{
  return data_prefix_;
}
 
inline bool
IOManager::overwrite_files() const
{
  return overwrite_files_;
}
 
}  // namespace nest
 
#endif /* #ifndef IO_MANAGER_H */