core::scoring::disulfides::CentroidDisulfideNeighborConstIterator Class Reference

Just a const version of CentroidDisulfideNeighborIterator. More...

#include <CentroidDisulfideEnergyContainer.hh>

Inheritance diagram for core::scoring::disulfides::CentroidDisulfideNeighborConstIterator:

Public Member Functions
	CentroidDisulfideNeighborConstIterator (CentroidDisulfideEnergyContainer const *owner, Size focused_node, Size disulfide_index)
	CentroidDisulfideNeighborConstIterator (CentroidDisulfideEnergyContainer const *owner)
	~CentroidDisulfideNeighborConstIterator () override
ResidueNeighborConstIterator &	operator= (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

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

Private Attributes
CentroidDisulfideEnergyContainer const *	owner_
Size	focused_residue_
Size	disulfide_index_

Detailed Description

Just a const version of CentroidDisulfideNeighborIterator.

Constructor & Destructor Documentation

core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::CentroidDisulfideNeighborConstIterator	(	CentroidDisulfideEnergyContainer const *	owner,
		Size	focused_node,
		Size	disulfide_index
	)

core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::CentroidDisulfideNeighborConstIterator

(

CentroidDisulfideEnergyContainer const *

owner

)

core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::~CentroidDisulfideNeighborConstIterator ( )

overridedefault

Member Function Documentation

void core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::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::disulfides::CentroidDisulfideEnergyContainer::accumulate_energy(), disulfide_index_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE, and owner_.

bool core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::energy_computed ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::energy_computed(), core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE, and owner_.

Size core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::lower_neighbor_id ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::lower_neighbor_id(), core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE, and owner_.

Size core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::neighbor_id ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::other_neighbor_id(), and owner_.

bool core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::operator!= ( ResidueNeighborConstIterator const &  rhs ) const

overridevirtual

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

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, and owner_.

ResidueNeighborConstIterator const & core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::operator++ ( )

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, and core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE.

CentroidDisulfideNeighborConstIterator& core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::operator= ( CentroidDisulfideNeighborConstIterator const &  )

private

ResidueNeighborConstIterator & core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::operator= ( ResidueNeighborConstIterator const &  rhs )

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, and owner_.

bool core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::operator== ( ResidueNeighborConstIterator const &  rhs ) const

overridevirtual

returns true if the two edge-list iterators are equal

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, and owner_.

Size core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::residue_iterated_on ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References focused_residue_.

void core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::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 disulfide_index_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE, owner_, and core::scoring::disulfides::CentroidDisulfideEnergyContainer::retrieve_energy().

Size core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::upper_neighbor_id ( ) const

overridevirtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE, owner_, and core::scoring::disulfides::CentroidDisulfideEnergyContainer::upper_neighbor_id().

Member Data Documentation

Size core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::disulfide_index_

private

Referenced by accumulate_energy(), energy_computed(), lower_neighbor_id(), neighbor_id(), operator!=(), operator++(), operator=(), operator==(), retrieve_energy(), and upper_neighbor_id().

Size core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::focused_residue_

private

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

CentroidDisulfideEnergyContainer const* core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::owner_

private

Referenced by accumulate_energy(), energy_computed(), lower_neighbor_id(), neighbor_id(), operator!=(), operator=(), operator==(), retrieve_energy(), and upper_neighbor_id().

---

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

• src/core/scoring/disulfides/CentroidDisulfideEnergyContainer.hh
• src/core/scoring/disulfides/CentroidDisulfideEnergyContainer.cc