Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
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>

Inheritance diagram for protocols::loops::ResidueIndexDescription:
Inheritance graph
[legend]
Collaboration diagram for protocols::loops::ResidueIndexDescription:
Collaboration graph
[legend]

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
char protocols::loops::ResidueIndexDescription::insertion_code ( ) const
inline
core::Size protocols::loops::ResidueIndexDescription::pose_index ( ) const
inline
bool protocols::loops::ResidueIndexDescription::pose_numbered ( ) const
inline
int protocols::loops::ResidueIndexDescription::resindex ( ) const
inline
core::Size protocols::loops::ResidueIndexDescription::resolve_index ( core::pose::Pose const &  p) const
bool protocols::loops::ResidueIndexDescription::unassigned ( ) const
inline

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: