Handle to atom datatype. More...
#include <atom_handle.hh>
Inherits ost::mol::AtomBase.
Public Member Functions | |
AtomHandle () | |
AtomHandle (const impl::AtomImplPtr &impl) | |
ResidueHandle | GetResidue () const |
EntityHandle | GetEntity () const |
AtomHandle | GetHandle () const |
long | GetHashCode () const |
bool | operator== (const AtomHandle &ref) const |
bool | operator!= (const AtomHandle &ref) const |
Bonds | |
int | GetBondCount () const |
BondHandleList | GetBondList () const |
BondHandle | FindBondToAtom (const AtomHandle &handle) const |
AtomHandleList | GetBondPartners () const |
Traversing the hierarchy | |
void | Apply (EntityVisitor &) |
Handle to atom datatype.
The bonds of an atom are accessible via GetBondList(). For a list of atoms that this atom is bonded to, use GetBondPartners().
New bonds are formed with one of the EditorBase::Connect() methods.
A valid atom handle is always part of a residue.
Definition at line 37 of file atom_handle.hh.
AtomHandle | ( | ) |
AtomHandle | ( | const impl::AtomImplPtr & | impl | ) |
void Apply | ( | EntityVisitor & | ) |
Apply visitor.
This method is used by the EntityVisitor interface to traverse the entity - chain - residue -atom hierarchy.
BondHandle FindBondToAtom | ( | const AtomHandle & | handle | ) | const |
Find bond to specific atom.
int GetBondCount | ( | ) | const |
Get number of bonds this atom forms.
Count of all bonds where this atom is either the first or second atom.
BondHandleList GetBondList | ( | ) | const |
get bond list
Returns all bonds where this atom is either the first or second atom.
AtomHandleList GetBondPartners | ( | ) | const |
Get all atoms this atom is bonded to.
EntityHandle GetEntity | ( | ) | const |
AtomHandle GetHandle | ( | ) | const |
get this handle
Useful for duck-typing in Python and templated code.
long GetHashCode | ( | ) | const |
Get unique identifier for atom.
Get hash code that uniquely identifies every atom. The hash code is identical for all atom views pointing to a given atom.
ResidueHandle GetResidue | ( | ) | const |
bool operator!= | ( | const AtomHandle & | ref | ) | const |
bool operator== | ( | const AtomHandle & | ref | ) | const |