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::ResidueIndexDescriptionRefPose Class Reference

a class which represents a residue index as a reference-pose enabled information. More...

#include <ResidueIndexDescription.hh>

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

Public Member Functions

 ResidueIndexDescriptionRefPose (std::string const &refpose_name, core::Size refpose_number, signed long refpose_offset)
 
 ResidueIndexDescriptionRefPose (RID_SourceCOP source, std::string const &refpose_name, core::Size refpose_number, signed long refpose_offset)
 
 ~ResidueIndexDescriptionRefPose () override
 
std::string const & refpose_name () const
 
core::Size refpose_number () const
 
signed long refpose_offset () 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

std::string refpose_name_
 
core::Size refpose_number_
 
signed long refpose_offset_
 

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 reference-pose enabled information.

Constructor & Destructor Documentation

core::pose::ResidueIndexDescriptionRefPose::ResidueIndexDescriptionRefPose ( std::string const &  refpose_name,
core::Size  refpose_number,
signed long  refpose_offset 
)
inline
core::pose::ResidueIndexDescriptionRefPose::ResidueIndexDescriptionRefPose ( RID_SourceCOP  source,
std::string const &  refpose_name,
core::Size  refpose_number,
signed long  refpose_offset 
)
inline
core::pose::ResidueIndexDescriptionRefPose::~ResidueIndexDescriptionRefPose ( )
overridedefault

Member Function Documentation

std::string const& core::pose::ResidueIndexDescriptionRefPose::refpose_name ( ) const
inline

References refpose_name_.

core::Size core::pose::ResidueIndexDescriptionRefPose::refpose_number ( ) const
inline

References refpose_number_.

signed long core::pose::ResidueIndexDescriptionRefPose::refpose_offset ( ) const
inline

References refpose_offset_.

core::Size core::pose::ResidueIndexDescriptionRefPose::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::get_resnumber_from_reference_pose(), refpose_name_, refpose_number_, and refpose_offset_.

void core::pose::ResidueIndexDescriptionRefPose::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 refpose_name_, refpose_number_, and refpose_offset_.

Member Data Documentation

std::string core::pose::ResidueIndexDescriptionRefPose::refpose_name_
private

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

core::Size core::pose::ResidueIndexDescriptionRefPose::refpose_number_
private

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

signed long core::pose::ResidueIndexDescriptionRefPose::refpose_offset_
private

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


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