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

a class which represents a residue index as a literal, Rosetta/Pose numbered integer More...

#include <ResidueIndexDescription.hh>

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

Public Member Functions

 ResidueIndexDescriptionPoseNum (Size pose_index)
 
 ResidueIndexDescriptionPoseNum (RID_SourceCOP source, Size pose_index)
 
 ~ResidueIndexDescriptionPoseNum () override
 
Size pose_index () const
 
Size resolve_index (core::pose::Pose const &p, bool no_error=false) const override
 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...
 
void show (std::ostream &) const override
 Output a description of the residue. More...
 
- Public Member Functions inherited from core::pose::ResidueIndexDescription
 ResidueIndexDescription ()
 
 ResidueIndexDescription (RID_SourceCOP source)
 
 ~ResidueIndexDescription () override
 
RID_SourceCOP get_source () const
 

Private Attributes

Size pose_index_
 

Additional Inherited Members

- Protected Member Functions inherited from core::pose::ResidueIndexDescription
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...
 

Detailed Description

a class which represents a residue index as a literal, Rosetta/Pose numbered integer

Constructor & Destructor Documentation

core::pose::ResidueIndexDescriptionPoseNum::ResidueIndexDescriptionPoseNum ( Size  pose_index)
inline
core::pose::ResidueIndexDescriptionPoseNum::ResidueIndexDescriptionPoseNum ( RID_SourceCOP  source,
Size  pose_index 
)
inline
core::pose::ResidueIndexDescriptionPoseNum::~ResidueIndexDescriptionPoseNum ( )
overridedefault

Member Function Documentation

Size core::pose::ResidueIndexDescriptionPoseNum::pose_index ( ) const
inline

References pose_index_.

core::Size core::pose::ResidueIndexDescriptionPoseNum::resolve_index ( core::pose::Pose const &  p,
bool  no_error = false 
) const
overridevirtual

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.

Implements core::pose::ResidueIndexDescription.

References core::pose::ResidueIndexDescription::do_error(), pose_index_, core::pose::Pose::size(), core::pose::ResidueIndexDescription::source_string(), and core::id::to_string().

void core::pose::ResidueIndexDescriptionPoseNum::show ( std::ostream &  ) const
overridevirtual

Output a description of the residue.

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

Implements core::pose::ResidueIndexDescription.

References pose_index_.

Member Data Documentation

Size core::pose::ResidueIndexDescriptionPoseNum::pose_index_
private

Referenced by pose_index(), resolve_index(), and show().


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