modelrange_manager.h

Go to the documentation of this file.

/*
 *  modelrange_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 MODELRANGEMANAGER_H
#define MODELRANGEMANAGER_H
 
// C++ includes:
#include <vector>
 
// Includes from libnestutil:
#include "manager_interface.h"
 
// Includes from nestkernel:
#include "modelrange.h"
#include "nest_types.h"
 
namespace nest
{
class Model;
 
class ModelRangeManager : public ManagerInterface
{
public:
  ModelRangeManager();
  ~ModelRangeManager() override
  {
  }
 
  void initialize( const bool ) override;
  void finalize( const bool ) override;
  void set_status( const Dictionary& ) override;
  void get_status( Dictionary& ) override;
 
  void add_range( size_t model, size_t first_node_id, size_t last_node_id );
 
  bool is_in_range( size_t node_id ) const;
 
  size_t get_model_id( size_t node_id ) const;
 
  Model* get_model_of_node_id( size_t );
 
  const modelrange& get_contiguous_node_id_range( size_t node_id ) const;
 
  std::vector< modelrange >::const_iterator begin() const;
 
  std::vector< modelrange >::const_iterator end() const;
 
private:
  std::vector< modelrange > modelranges_;
  size_t first_node_id_;
  size_t last_node_id_;
};
 
inline void
ModelRangeManager::set_status( const Dictionary& )
{
}
 
inline void
ModelRangeManager::get_status( Dictionary& )
{
}
 
inline bool
ModelRangeManager::is_in_range( size_t node_id ) const
{
  return ( node_id > 0 and node_id <= last_node_id_ and node_id >= first_node_id_ );
}
 
inline std::vector< modelrange >::const_iterator
ModelRangeManager::begin() const
{
  return modelranges_.begin();
}
 
inline std::vector< modelrange >::const_iterator
ModelRangeManager::end() const
{
  return modelranges_.end();
}
 
}  // namespace nest end
 
#endif