core::scoring::constraints::CstResNeighbIterator Class Reference

#include <ConstraintEnergyContainer.hh>

Inheritance diagram for core::scoring::constraints::CstResNeighbIterator:

Public Types
typedef utility::graph::Node::EdgeListIter	EdgeListIter

Public Member Functions
	CstResNeighbIterator (Size focused_node, EdgeListIter edge_iter)
	~CstResNeighbIterator () override
ResidueNeighborIterator &	operator= (ResidueNeighborIterator const &) override
ResidueNeighborIterator const &	operator++ () override
bool	operator== (ResidueNeighborIterator const &) const override
bool	operator!= (ResidueNeighborIterator const &) const override
Size	upper_neighbor_id () const override
Size	lower_neighbor_id () const override
Size	residue_iterated_on () const override
Size	neighbor_id () const override
void	save_energy (EnergyMap const &) override
void	retrieve_energy (EnergyMap &) const override
void	accumulate_energy (EnergyMap &) const override
void	mark_energy_computed () override
void	mark_energy_uncomputed () override
bool	energy_computed () const override
Public Member Functions inherited from core::scoring::ResidueNeighborIterator
	~ResidueNeighborIterator () override

Static Protected Member Functions
static ConstraintEdge *	downcast_cstedge (utility::graph::Edge *)

Private Member Functions
CstResNeighbIterator &	operator= (CstResNeighbIterator const &)

Private Attributes
Size	focused_node_
EdgeListIter	edge_iter_

Member Typedef Documentation

EdgeListIter

typedef utility::graph::Node::EdgeListIter core::scoring::constraints::CstResNeighbIterator::EdgeListIter

Constructor & Destructor Documentation

CstResNeighbIterator()

core::scoring::constraints::CstResNeighbIterator::CstResNeighbIterator	(	Size	focused_node,
		CstResNeighbIterator::EdgeListIter	edge_iter
	)

~CstResNeighbIterator()

core::scoring::constraints::CstResNeighbIterator::~CstResNeighbIterator ( )

overridedefault

Member Function Documentation

accumulate_energy()

void core::scoring::constraints::CstResNeighbIterator::accumulate_energy ( EnergyMap &  emap ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References core::scoring::angle_constraint, core::scoring::constraints::ConstraintEdge::angle_constraint_energy(), core::scoring::atom_pair_constraint, core::scoring::constraints::ConstraintEdge::atom_pair_constraint_energy(), core::scoring::backbone_stub_constraint, core::scoring::constraints::ConstraintEdge::backbone_stub_constraint_energy(), core::scoring::backbone_stub_linear_constraint, core::scoring::constraints::ConstraintEdge::backbone_stub_linear_constraint_energy(), core::scoring::base_pair_constraint, core::scoring::constraints::ConstraintEdge::base_pair_constraint_energy(), core::scoring::bond_geometry, core::scoring::constraints::ConstraintEdge::bond_geometry_energy(), core::scoring::coordinate_constraint, core::scoring::constraints::ConstraintEdge::coordinate_constraint_energy(), core::scoring::dihedral_constraint, core::scoring::constraints::ConstraintEdge::dihedral_constraint_energy(), downcast_cstedge(), core::scoring::metalbinding_constraint, core::scoring::constraints::ConstraintEdge::metalbinding_constraint_energy(), core::scoring::res_type_linking_constraint, core::scoring::constraints::ConstraintEdge::res_type_linking_constraint_energy(), core::scoring::rna_bond_geometry, and core::scoring::constraints::ConstraintEdge::rna_bond_geometry_energy().

downcast_cstedge()

ConstraintEdge * core::scoring::constraints::CstResNeighbIterator::downcast_cstedge ( utility::graph::Edge *  edge )

staticprotected

Referenced by accumulate_energy(), energy_computed(), mark_energy_computed(), mark_energy_uncomputed(), retrieve_energy(), and save_energy().

energy_computed()

bool core::scoring::constraints::CstResNeighbIterator::energy_computed ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References downcast_cstedge(), and core::scoring::constraints::ConstraintEdge::energy_computed().

lower_neighbor_id()

Size core::scoring::constraints::CstResNeighbIterator::lower_neighbor_id ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

mark_energy_computed()

void core::scoring::constraints::CstResNeighbIterator::mark_energy_computed ( )

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References downcast_cstedge(), and core::scoring::constraints::ConstraintEdge::energy_computed().

mark_energy_uncomputed()

void core::scoring::constraints::CstResNeighbIterator::mark_energy_uncomputed ( )

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References downcast_cstedge(), and core::scoring::constraints::ConstraintEdge::energy_computed().

neighbor_id()

Size core::scoring::constraints::CstResNeighbIterator::neighbor_id ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References focused_node_.

operator!=()

bool core::scoring::constraints::CstResNeighbIterator::operator!= ( ResidueNeighborIterator const &  rhs ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References edge_iter_.

operator++()

ResidueNeighborIterator const & core::scoring::constraints::CstResNeighbIterator::operator++ ( )

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References edge_iter_.

operator=() [1/2]

CstResNeighbIterator& core::scoring::constraints::CstResNeighbIterator::operator= ( CstResNeighbIterator const &  )

private

operator=() [2/2]

ResidueNeighborIterator & core::scoring::constraints::CstResNeighbIterator::operator= ( ResidueNeighborIterator const &  rhs )

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References edge_iter_, and focused_node_.

operator==()

bool core::scoring::constraints::CstResNeighbIterator::operator== ( ResidueNeighborIterator const &  rhs ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References edge_iter_.

residue_iterated_on()

Size core::scoring::constraints::CstResNeighbIterator::residue_iterated_on ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References focused_node_.

retrieve_energy()

void core::scoring::constraints::CstResNeighbIterator::retrieve_energy ( EnergyMap &  emap ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References core::scoring::angle_constraint, core::scoring::constraints::ConstraintEdge::angle_constraint_energy(), core::scoring::atom_pair_constraint, core::scoring::constraints::ConstraintEdge::atom_pair_constraint_energy(), core::scoring::backbone_stub_constraint, core::scoring::constraints::ConstraintEdge::backbone_stub_constraint_energy(), core::scoring::base_pair_constraint, core::scoring::constraints::ConstraintEdge::base_pair_constraint_energy(), core::scoring::bond_geometry, core::scoring::constraints::ConstraintEdge::bond_geometry_energy(), core::scoring::coordinate_constraint, core::scoring::constraints::ConstraintEdge::coordinate_constraint_energy(), core::scoring::dihedral_constraint, core::scoring::constraints::ConstraintEdge::dihedral_constraint_energy(), downcast_cstedge(), core::scoring::metalbinding_constraint, core::scoring::constraints::ConstraintEdge::metalbinding_constraint_energy(), core::scoring::res_type_linking_constraint, core::scoring::constraints::ConstraintEdge::res_type_linking_constraint_energy(), core::scoring::rna_bond_geometry, and core::scoring::constraints::ConstraintEdge::rna_bond_geometry_energy().

save_energy()

void core::scoring::constraints::CstResNeighbIterator::save_energy ( EnergyMap const &  emap )

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

References core::scoring::angle_constraint, core::scoring::constraints::ConstraintEdge::angle_constraint_energy(), core::scoring::atom_pair_constraint, core::scoring::constraints::ConstraintEdge::atom_pair_constraint_energy(), core::scoring::backbone_stub_constraint, core::scoring::constraints::ConstraintEdge::backbone_stub_constraint_energy(), core::scoring::backbone_stub_linear_constraint, core::scoring::constraints::ConstraintEdge::backbone_stub_linear_constraint_energy(), core::scoring::base_pair_constraint, core::scoring::constraints::ConstraintEdge::base_pair_constraint_energy(), core::scoring::bond_geometry, core::scoring::constraints::ConstraintEdge::bond_geometry_energy(), core::scoring::coordinate_constraint, core::scoring::constraints::ConstraintEdge::coordinate_constraint_energy(), core::scoring::dihedral_constraint, core::scoring::constraints::ConstraintEdge::dihedral_constraint_energy(), downcast_cstedge(), core::scoring::metalbinding_constraint, core::scoring::constraints::ConstraintEdge::metalbinding_constraint_energy(), core::scoring::res_type_linking_constraint, core::scoring::constraints::ConstraintEdge::res_type_linking_constraint_energy(), core::scoring::rna_bond_geometry, and core::scoring::constraints::ConstraintEdge::rna_bond_geometry_energy().

upper_neighbor_id()

Size core::scoring::constraints::CstResNeighbIterator::upper_neighbor_id ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborIterator.

Member Data Documentation

edge_iter_

EdgeListIter core::scoring::constraints::CstResNeighbIterator::edge_iter_

private

Referenced by operator!=(), operator++(), operator=(), and operator==().

focused_node_

Size core::scoring::constraints::CstResNeighbIterator::focused_node_

private

Referenced by neighbor_id(), operator=(), and residue_iterated_on().

---

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

• src/core/scoring/constraints/ConstraintEnergyContainer.hh
• src/core/scoring/constraints/ConstraintEnergyContainer.cc