core::pose::ResidueIndexDescriptionLastResidue Class Reference

a class which represents the last residue in the Pose More...

#include <ResidueIndexDescription.hh>

Inheritance diagram for core::pose::ResidueIndexDescriptionLastResidue:

Public Member Functions
	ResidueIndexDescriptionLastResidue ()
	ResidueIndexDescriptionLastResidue (RID_SourceCOP source)
	~ResidueIndexDescriptionLastResidue () override
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

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 the last residue in the Pose

Constructor & Destructor Documentation

core::pose::ResidueIndexDescriptionLastResidue::ResidueIndexDescriptionLastResidue ( )

inline

core::pose::ResidueIndexDescriptionLastResidue::ResidueIndexDescriptionLastResidue ( RID_SourceCOP  source )

inline

core::pose::ResidueIndexDescriptionLastResidue::~ResidueIndexDescriptionLastResidue ( )

overridedefault

Member Function Documentation

core::Size core::pose::ResidueIndexDescriptionLastResidue::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::Pose::size().

void core::pose::ResidueIndexDescriptionLastResidue::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.

---

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

• src/core/pose/ResidueIndexDescription.hh
• src/core/pose/ResidueIndexDescription.cc