AtomView Class Reference

definition of AtomView More...

#include <atom_view.hh>

Inherits ost::mol::AtomBase.

Public Member Functions
	AtomView ()
	AtomView (const ResidueView &residue_view, const AtomHandle &atom)
ResidueView	GetResidue () const
EntityView	GetEntity () const
AtomHandle	GetHandle () const
BondHandleList	GetBondList () const
int	GetBondCount () const
AtomViewList	GetBondPartners () const
void	RemoveBonds ()
void	Apply (EntityVisitor &visitor)
void	Apply (EntityViewVisitor &visitor)
long	GetHashCode () const
bool	operator== (const AtomView &rhs) const
bool	operator!= (const AtomView &rhs) const
View validity
	operator bool () const
bool	IsValid () const
Protected Member Functions
bool	AddBond (const BondHandle &bond)
void	RemoveBondInternal (const BondHandle &bond)
Friends
class	EntityView

---

Detailed Description

definition of AtomView

Definition at line 34 of file atom_view.hh.

---

Constructor & Destructor Documentation

AtomView

(

)

AtomView	(	const ResidueView &	residue_view,
		const AtomHandle &	atom
	)

---

Member Function Documentation

bool AddBond

(

const BondHandle &

bond

)

[protected]

Add bond to atom. If the bond is already present, it will not be added again.

Parameters:

bond

The bond to add

Returns:

true if the bond has been added, false if the bond was already present in the list

void Apply

(

EntityViewVisitor &

visitor

)

void Apply

(

EntityVisitor &

visitor

)

Apply entity visitor to this atom.

int GetBondCount

(

)

const

Get bond count Only bonds included in the view will be counted. To count all bonds of the the atom, use `atom.GetHandle().GetBondCount()`.

BondHandleList GetBondList

(

)

const

Get bond list Only bonds included in the view will be returned. To get all bonds of the the atom, use `atom.GetHandle().GetBondList()`.

AtomViewList GetBondPartners

(

)

const

Get all atoms this atom is bonded to.

EntityView GetEntity

(

)

const

Shortcut to entity.

AtomHandle GetHandle

(

)

const

Get handle this view points to.

long GetHashCode

(

)

const

get unique id

The unique id is the same for all AtomViews pointing to the same atom view data.

ResidueView GetResidue

(

)

const

Get parent residue view.

bool IsValid

(

)

const [inline]

check validity of handle

See also:

operator bool()

Reimplemented from AtomBase.

Definition at line 50 of file atom_view.hh.

operator bool

(

)

const [inline]

check validity of view

check, whether the atom view points to a valid atom.

Note:

It is an error to use any method other than IsValid, Impl and operator bool() when the handle is invalid. An InvalidHandle exception will be thrown.

Reimplemented from AtomBase.

Definition at line 47 of file atom_view.hh.

bool operator!=

(

const AtomView &

rhs

)

const

bool operator==

(

const AtomView &

rhs

)

const

void RemoveBondInternal

(

const BondHandle &

bond

)

[protected]

void RemoveBonds

(

)

Remove all bonds this atom is involved in.

---

Friends And Related Function Documentation

friend class EntityView [friend]

Definition at line 36 of file atom_view.hh.

---

The documentation for this class was generated from the following file:

• stage/include/ost/mol/atom_view.hh