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

Just a const version of CentroidDisulfideNeighborIterator. More...

#include <CentroidDisulfideEnergyContainer.hh>

Public Member Functions
	CentroidDisulfideNeighborConstIterator (CentroidDisulfideEnergyContainerCAP owner, Size focused_node, Size disulfide_index)
	CentroidDisulfideNeighborConstIterator (CentroidDisulfideEnergyContainerCAP owner)
virtual	~CentroidDisulfideNeighborConstIterator ()
virtual ResidueNeighborConstIterator const &	operator= (ResidueNeighborConstIterator const &)
virtual ResidueNeighborConstIterator const &	operator++ ()
virtual bool	operator== (ResidueNeighborConstIterator const &) const
	returns true if the two edge-list iterators are equal More...
virtual bool	operator!= (ResidueNeighborConstIterator const &) const
	returns true if the two edge-list iterators are not equal More...
virtual Size	upper_neighbor_id () const
virtual Size	lower_neighbor_id () const
virtual Size	residue_iterated_on () const
virtual Size	neighbor_id () const
virtual void	retrieve_energy (EnergyMap &) const
	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...
virtual void	accumulate_energy (EnergyMap &) const
	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...
virtual bool	energy_computed () const
Public Member Functions inherited from core::scoring::ResidueNeighborConstIterator
virtual	~ResidueNeighborConstIterator ()

Private Attributes
CentroidDisulfideEnergyContainerCAP	owner_
Size	focused_residue_
Size	disulfide_index_

Detailed Description

Just a const version of CentroidDisulfideNeighborIterator.

Constructor & Destructor Documentation

core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::CentroidDisulfideNeighborConstIterator	(	CentroidDisulfideEnergyContainerCAP	owner,
		Size	focused_node,
		Size	disulfide_index
	)

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

(

CentroidDisulfideEnergyContainerCAP

owner

)

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

virtual

Member Function Documentation

void core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::accumulate_energy ( EnergyMap &  emap ) const

virtual

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 disulfide_index_, core::scoring::disulfides::CentroidDisulfideEnergyContainer::NO_DISULFIDE, and owner_.

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

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

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

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

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, and owner_.

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

virtual

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

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

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

References disulfide_index_, focused_residue_, and owner_.

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

virtual

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

References focused_residue_.

void core::scoring::disulfides::CentroidDisulfideNeighborConstIterator::retrieve_energy ( EnergyMap &  emap ) const

virtual

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, and owner_.

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

virtual

Implements core::scoring::ResidueNeighborConstIterator.

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

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

CentroidDisulfideEnergyContainerCAP 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