OpenStructure
atom_handle.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of the OpenStructure project <www.openstructure.org>
3 //
4 // Copyright (C) 2008-2011 by the OpenStructure authors
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License as published by the Free
8 // Software Foundation; either version 3.0 of the License, or (at your option)
9 // any later version.
10 // This library is distributed in the hope that it will be useful, but WITHOUT
11 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13 // details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with this library; if not, write to the Free Software Foundation, Inc.,
17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //------------------------------------------------------------------------------
19 #ifndef OST_ATOM_HANDLE_HR
20 #define OST_ATOM_HANDLE_HR
21 
22 #include <ost/mol/module_config.hh>
23 #include <ost/mol/atom_base.hh>
26 
27 namespace ost { namespace mol {
28 
38 public:
39  AtomHandle();
40  AtomHandle(const impl::AtomImplPtr& impl);
41 
42 public:
43 
44  ResidueHandle GetResidue() const;
45 
46  EntityHandle GetEntity() const;
47 
49 
50 
51 
52 
53 
54  int GetBondCount() const;
55 
60  BondHandleList GetBondList() const;
61 
65  BondHandle FindBondToAtom(const AtomHandle& handle) const;
66 
68  AtomHandleList GetBondPartners() const;
70 
72 
73 
74 
75 
76 
77 
78  void Apply(EntityVisitor&);
80 
84  AtomHandle GetHandle() const;
85 
90  long GetHashCode() const;
91 
92  bool operator==(const AtomHandle& ref) const;
93  bool operator!=(const AtomHandle& ref) const;
94 
95 };
96 
97 }} // ns
98 
99 #endif // OST_ATOM_HANDLE_HH