Chemical Data Processing Library C++ API - Version 1.1.1
HierarchyViewModel.hpp
Go to the documentation of this file.
1 /*
2  * HierarchyViewModel.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_BIOMOL_HIERARCHYVIEWMODEL_HPP
30 #define CDPL_BIOMOL_HIERARCHYVIEWMODEL_HPP
31 
32 #include <cstddef>
33 #include <vector>
34 #include <string>
35 #include <unordered_map>
36 #include <memory>
37 
38 #include <boost/iterator/indirect_iterator.hpp>
39 
42 
43 
44 namespace CDPL
45 {
46 
47  namespace Biomol
48  {
49 
50  class HierarchyView;
51 
56  {
57 
58  friend class HierarchyView;
59 
60  typedef std::shared_ptr<HierarchyViewChain> ChainPtr;
61  typedef std::vector<ChainPtr> ChainList;
62 
63  public:
64  typedef boost::indirect_iterator<ChainList::const_iterator, const HierarchyViewChain> ConstChainIterator;
65 
66  std::size_t getNumChains() const;
67 
68  const HierarchyViewChain& getChain(std::size_t idx) const;
69 
70  bool hasChainWithID(const std::string& id) const;
71 
72  const HierarchyViewChain& getChainByID(const std::string& id) const;
73 
75 
77 
79 
81 
82  private:
84  initChains(true) {}
85 
86  void initChainList() const;
87 
88  typedef std::unordered_map<std::string, ChainPtr> IDToChainMap;
89 
90  mutable ChainList chains;
91  mutable IDToChainMap idToChainMap;
92  mutable bool initChains;
93  };
94  } // namespace Biomol
95 } // namespace CDPL
96 
97 #endif // CDPL_BIOMOL_HIERARCHYVIEWMODEL_HPP
CDPL::Biomol::HierarchyViewModel
HierarchyViewModel.
Definition: HierarchyViewModel.hpp:56
CDPL::Biomol::HierarchyViewChain
HierarchyViewChain.
Definition: HierarchyViewChain.hpp:55
CDPL::Biomol::HierarchyViewModel::getChainsBegin
ConstChainIterator getChainsBegin() const
CDPL::Biomol::HierarchyViewModel::getNumChains
std::size_t getNumChains() const
CDPL::Biomol::HierarchyViewModel::getChainByID
const HierarchyViewChain & getChainByID(const std::string &id) const
CDPL::Biomol::HierarchyViewModel::ConstChainIterator
boost::indirect_iterator< ChainList::const_iterator, const HierarchyViewChain > ConstChainIterator
Definition: HierarchyViewModel.hpp:64
CDPL::Biomol::HierarchyViewModel::hasChainWithID
bool hasChainWithID(const std::string &id) const
CDPL::Biomol::HierarchyViewNode
HierarchyViewNode.
Definition: HierarchyViewNode.hpp:48
CDPL::Biomol::HierarchyViewModel::getChain
const HierarchyViewChain & getChain(std::size_t idx) const
CDPL::Biomol::HierarchyViewModel::getChainsEnd
ConstChainIterator getChainsEnd() const
APIPrefix.hpp
Definition of the preprocessor macro CDPL_BIOMOL_API.
CDPL::Biomol::HierarchyViewModel::end
ConstChainIterator end() const
CDPL
The namespace of the Chemical Data Processing Library.
CDPL::Biomol::HierarchyViewModel::begin
ConstChainIterator begin() const
CDPL::Biomol::HierarchyView
A datastructure allowing a hierarchical view on biological macromolecules.
Definition: HierarchyView.hpp:55
HierarchyViewChain.hpp
Definition of the class CDPL::Biomol::HierarchyViewChain.
CDPL_BIOMOL_API
#define CDPL_BIOMOL_API
Tells the compiler/linker which classes, functions and variables are part of the library API.