Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
core::pose::ResidueIndexDescription Class Referenceabstract

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 <ResidueIndexDescription.hh>

Inheritance diagram for core::pose::ResidueIndexDescription:
Inheritance graph
[legend]

Public Member Functions

 ResidueIndexDescription ()
 
 ResidueIndexDescription (RID_SourceCOP source)
 
 ~ResidueIndexDescription () override
 
virtual Size resolve_index (core::pose::Pose const &p, bool no_error=false) const =0
 Turn the internal data into a pose index (in the range from 1 to total residue) If it can't be converted, throw an exception, unless no_error is true. If no_error is true, return 0 or a residue number outside the pose range. More...
 
virtual void show (std::ostream &) const =0
 Output a description of the residue. More...
 
RID_SourceCOP get_source () const
 

Protected Member Functions

std::string source_string () const
 Provide a formatted string representing the source of the information (if any) More...
 
core::Size do_error (bool no_error, std::string const &msg) const
 Convenience function for triggering error conditions. More...
 

Private Attributes

RID_SourceCOP source_
 

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

core::pose::ResidueIndexDescription::ResidueIndexDescription ( )
inline
core::pose::ResidueIndexDescription::ResidueIndexDescription ( RID_SourceCOP  source)
inline
core::pose::ResidueIndexDescription::~ResidueIndexDescription ( )
overridedefault

Member Function Documentation

core::Size core::pose::ResidueIndexDescription::do_error ( bool  no_error,
std::string const &  msg 
) const
protected
RID_SourceCOP core::pose::ResidueIndexDescription::get_source ( ) const
inline

References source_.

virtual Size core::pose::ResidueIndexDescription::resolve_index ( core::pose::Pose const &  p,
bool  no_error = false 
) const
pure virtual

Turn the internal data into a pose index (in the range from 1 to total residue) If it can't be converted, throw an exception, unless no_error is true. If no_error is true, return 0 or a residue number outside the pose range.

Implemented in core::pose::ResidueIndexDescriptionChainEnd, core::pose::ResidueIndexDescriptionLastResidue, core::pose::ResidueIndexDescriptionRefPose, core::pose::ResidueIndexDescriptionPDB, and core::pose::ResidueIndexDescriptionPoseNum.

virtual void core::pose::ResidueIndexDescription::show ( std::ostream &  ) const
pure virtual

Output a description of the residue.

In general will give a form which can be added "in-line" (no line ending)

Implemented in core::pose::ResidueIndexDescriptionChainEnd, core::pose::ResidueIndexDescriptionLastResidue, core::pose::ResidueIndexDescriptionRefPose, core::pose::ResidueIndexDescriptionPDB, and core::pose::ResidueIndexDescriptionPoseNum.

Referenced by core::pose::operator<<().

std::string core::pose::ResidueIndexDescription::source_string ( ) const
protected

Member Data Documentation

RID_SourceCOP core::pose::ResidueIndexDescription::source_
private

Referenced by get_source(), and source_string().


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