recordables_map.h

Go to the documentation of this file.

/*
 *  recordables_map.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 RECORDABLES_MAP_H
#define RECORDABLES_MAP_H
 
// C++ includes:
#include <cassert>
#include <map>
#include <string>
#include <utility>
 
// Includes from nestkernel:
#include "nest_types.h"
 
namespace nest
{
template < typename HostNode >
class RecordablesMap : public std::map< std::string, double ( HostNode::* )() const >
{
  typedef std::map< std::string, double ( HostNode::* )() const > Base_;
 
public:
  virtual ~RecordablesMap()
  {
  }
 
  typedef double ( HostNode::*DataAccessFct )() const;
 
  void create();
 
  std::vector< std::string >
  get_list() const
  {
    std::vector< std::string > recordables;
    for ( typename Base_::const_iterator it = this->begin(); it != this->end(); ++it )
    {
      recordables.push_back( it->first );
    }
    return recordables;
 
    // the entire function should just be
    // return recordables_;
  }
 
private:
  void
  insert_( const std::string& n, const DataAccessFct f )
  {
    Base_::insert( std::make_pair( n, f ) );
 
    // Line below leads to seg-fault if nest is quit right after start,
    // see comment on get_list()
    // recordables_.push_back(n);
  }
 
  // std::vector< std::string > recordables_;
};
 
template < typename HostNode >
void
RecordablesMap< HostNode >::create()
{
  assert( false );
}
 
 
template < typename HostNode >
class DataAccessFunctor
{
  // Pointer instead of reference required to avoid problems with
  // copying element in std::map when using libc++ under C++11.
  HostNode* parent_;
  size_t elem_;
 
public:
  DataAccessFunctor( HostNode& n, size_t elem )
    : parent_( &n )
    , elem_( elem ) {};
 
  double
  operator()() const
  {
    return parent_->get_state_element( elem_ );
  };
};
 
 
template < typename HostNode >
class DynamicRecordablesMap : public std::map< std::string, const DataAccessFunctor< HostNode > >
{
  typedef std::map< std::string, const DataAccessFunctor< HostNode > > Base_;
 
public:
  virtual ~DynamicRecordablesMap()
  {
  }
 
  typedef DataAccessFunctor< HostNode > DataAccessFct;
 
  void create( HostNode& n );
 
  std::vector< std::string >
  get_list() const
  {
    std::vector< std::string > recordables;
    for ( typename Base_::const_iterator it = this->begin(); it != this->end(); ++it )
    {
      recordables.push_back( it->first );
    }
    return recordables;
  }
 
  void
  insert( const std::string& n, const DataAccessFct& f )
  {
    Base_::insert( std::make_pair( n, f ) );
  }
 
  void
  erase( const std::string& n )
  {
    typename DynamicRecordablesMap< HostNode >::iterator it = this->find( n );
    // If the string is not in the map, throw an error
    if ( it == this->end() )
    {
      throw KeyError( n, "DynamicRecordablesMap", "erase" );
    }
 
    Base_::erase( it );
  }
};
 
template < typename HostNode >
void
DynamicRecordablesMap< HostNode >::create( HostNode& )
{
  assert( false );
}
}
 
#endif