protocols::loops::ResidueIndexDescription Class Reference

a class which can represent one of many ways in which to describe a particular residue in a pose, and can, when given a pose, find its index. The object should be constructed with all its needed parameters, but, one instance may be copied from another. More...

#include <LoopsFileIO.hh>

Public Member Functions
	ResidueIndexDescription ()
	ResidueIndexDescription (core::Size pose_index)
	ResidueIndexDescription (char chain, int resindex, char insertion_code= ' ')
core::Size	resolve_index (core::pose::Pose const &p) const
bool	unassigned () const
bool	pose_numbered () const
core::Size	pose_index () const
char	chain () const
int	resindex () const
char	insertion_code () const

Private Attributes
bool	unassigned_
bool	pose_numbered_
core::Size	pose_index_
char	chain_
int	resindex_
char	insertion_code_

Detailed Description

a class which can represent one of many ways in which to describe a particular residue in a pose, and can, when given a pose, find its index. The object should be constructed with all its needed parameters, but, one instance may be copied from another.

Constructor & Destructor Documentation

protocols::loops::ResidueIndexDescription::ResidueIndexDescription

(

)

protocols::loops::ResidueIndexDescription::ResidueIndexDescription

(

core::Size

pose_index

)

protocols::loops::ResidueIndexDescription::ResidueIndexDescription	(	char	chain,
		int	resindex,
		char	insertion_code = ' '
	)

Member Function Documentation

char protocols::loops::ResidueIndexDescription::chain ( ) const

inline

References chain_.

Referenced by protocols::loops::ResidueIndexDescriptionFromFile::resolve_index().

char protocols::loops::ResidueIndexDescription::insertion_code ( ) const

inline

References insertion_code_.

Referenced by resolve_index(), and protocols::loops::ResidueIndexDescriptionFromFile::resolve_index().

core::Size protocols::loops::ResidueIndexDescription::pose_index ( ) const

inline

References pose_index_.

Referenced by protocols::loops::ResidueIndexDescriptionFromFile::resolve_index().

bool protocols::loops::ResidueIndexDescription::pose_numbered ( ) const

inline

References pose_numbered_.

Referenced by protocols::loops::ResidueIndexDescriptionFromFile::resolve_index().

int protocols::loops::ResidueIndexDescription::resindex ( ) const

inline

References resindex_.

Referenced by protocols::loops::ResidueIndexDescriptionFromFile::resolve_index().

core::Size protocols::loops::ResidueIndexDescription::resolve_index

(

core::pose::Pose const &

p

)

const

References chain_, insertion_code(), insertion_code_, core::pose::Pose::pdb_info(), pose_index_, pose_numbered_, resindex_, utility::to_string(), core::pose::Pose::total_residue(), unassigned_, and utility_exit_with_message.

bool protocols::loops::ResidueIndexDescription::unassigned ( ) const

inline

References unassigned_.

Referenced by protocols::loops::ResidueIndexDescriptionFromFile::resolve_index().

Member Data Documentation

char protocols::loops::ResidueIndexDescription::chain_

private

Referenced by chain(), and resolve_index().

char protocols::loops::ResidueIndexDescription::insertion_code_

private

Referenced by insertion_code(), and resolve_index().

core::Size protocols::loops::ResidueIndexDescription::pose_index_

private

Referenced by pose_index(), and resolve_index().

bool protocols::loops::ResidueIndexDescription::pose_numbered_

private

Referenced by pose_numbered(), and resolve_index().

int protocols::loops::ResidueIndexDescription::resindex_

private

Referenced by resindex(), and resolve_index().

bool protocols::loops::ResidueIndexDescription::unassigned_

private

Referenced by resolve_index(), and unassigned().

---

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

• src/protocols/loops/LoopsFileIO.hh
• src/protocols/loops/LoopsFileIO.cc