Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Protected Member Functions | Private Member Functions | Private Attributes | List of all members
core::scoring::constraints::CstResNeighbConstIterator Class Reference

#include <ConstraintEnergyContainer.hh>

Inheritance diagram for core::scoring::constraints::CstResNeighbConstIterator:
Inheritance graph
[legend]

Public Types

typedef
utility::graph::Node::EdgeListConstIter 
EdgeListConstIter
 

Public Member Functions

 CstResNeighbConstIterator (Size focused_node, EdgeListConstIter edge_iter)
 
 ~CstResNeighbConstIterator () override
 
ResidueNeighborConstIteratoroperator= (ResidueNeighborConstIterator const &) override
 
ResidueNeighborConstIterator
const & 
operator++ () override
 
bool operator== (ResidueNeighborConstIterator const &) const override
 returns true if the two edge-list iterators are equal More...
 
bool operator!= (ResidueNeighborConstIterator const &) const override
 returns true if the two edge-list iterators are not equal More...
 
Size upper_neighbor_id () const override
 
Size lower_neighbor_id () const override
 
Size residue_iterated_on () const override
 
Size neighbor_id () const override
 
void retrieve_energy (EnergyMap &) const override
 overwrites the three constraint-energy positions in the emap with the three contraint energies stored on the edge pointed to by the edge iter. Does not zero out the other positions in the emap. More...
 
void accumulate_energy (EnergyMap &) const override
 accumulates the three constraint-energy positions in the emap with the three contraint energies stored on the edge pointed to by the edge iter. Does not touch the other positions in the emap. More...
 
bool energy_computed () const override
 
- Public Member Functions inherited from core::scoring::ResidueNeighborConstIterator
 ~ResidueNeighborConstIterator () override
 

Static Protected Member Functions

static ConstraintEdge const * downcast_cstedge (utility::graph::Edge const *)
 

Private Member Functions

CstResNeighbConstIteratoroperator= (CstResNeighbConstIterator const &)
 

Private Attributes

Size focused_node_
 
utility::graph::Node::EdgeListConstIter edge_iter_
 

Member Typedef Documentation

typedef utility::graph::Node::EdgeListConstIter core::scoring::constraints::CstResNeighbConstIterator::EdgeListConstIter

Constructor & Destructor Documentation

core::scoring::constraints::CstResNeighbConstIterator::CstResNeighbConstIterator ( Size  focused_node,
CstResNeighbConstIterator::EdgeListConstIter  edge_iter 
)
core::scoring::constraints::CstResNeighbConstIterator::~CstResNeighbConstIterator ( )
overridedefault

Member Function Documentation

void core::scoring::constraints::CstResNeighbConstIterator::accumulate_energy ( EnergyMap emap) const
overridevirtual

accumulates the three constraint-energy positions in the emap with the three contraint energies stored on the edge pointed to by the edge iter. Does not touch the other positions in the emap.

Implements core::scoring::ResidueNeighborConstIterator.

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().

ConstraintEdge const * core::scoring::constraints::CstResNeighbConstIterator::downcast_cstedge ( utility::graph::Edge const *  edge)
staticprotected
bool core::scoring::constraints::CstResNeighbConstIterator::energy_computed ( ) const
overridevirtual
Size core::scoring::constraints::CstResNeighbConstIterator::lower_neighbor_id ( ) const
overridevirtual
Size core::scoring::constraints::CstResNeighbConstIterator::neighbor_id ( ) const
overridevirtual
bool core::scoring::constraints::CstResNeighbConstIterator::operator!= ( ResidueNeighborConstIterator const &  rhs) const
overridevirtual

returns true if the two edge-list iterators are not equal

Implements core::scoring::ResidueNeighborConstIterator.

References edge_iter_.

ResidueNeighborConstIterator const & core::scoring::constraints::CstResNeighbConstIterator::operator++ ( )
overridevirtual
CstResNeighbConstIterator& core::scoring::constraints::CstResNeighbConstIterator::operator= ( CstResNeighbConstIterator const &  )
private
ResidueNeighborConstIterator & core::scoring::constraints::CstResNeighbConstIterator::operator= ( ResidueNeighborConstIterator const &  rhs)
overridevirtual
bool core::scoring::constraints::CstResNeighbConstIterator::operator== ( ResidueNeighborConstIterator const &  rhs) const
overridevirtual

returns true if the two edge-list iterators are equal

Implements core::scoring::ResidueNeighborConstIterator.

References edge_iter_.

Size core::scoring::constraints::CstResNeighbConstIterator::residue_iterated_on ( ) const
overridevirtual
void core::scoring::constraints::CstResNeighbConstIterator::retrieve_energy ( EnergyMap emap) const
overridevirtual

overwrites the three constraint-energy positions in the emap with the three contraint energies stored on the edge pointed to by the edge iter. Does not zero out the other positions in the emap.

Implements core::scoring::ResidueNeighborConstIterator.

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().

Size core::scoring::constraints::CstResNeighbConstIterator::upper_neighbor_id ( ) const
overridevirtual

Member Data Documentation

utility::graph::Node::EdgeListConstIter core::scoring::constraints::CstResNeighbConstIterator::edge_iter_
private
Size core::scoring::constraints::CstResNeighbConstIterator::focused_node_
private

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