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:

[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

◆ ResidueIndexDescription() [1/2]

core::pose::ResidueIndexDescription::ResidueIndexDescription ( )

inline

◆ ResidueIndexDescription() [2/2]

core::pose::ResidueIndexDescription::ResidueIndexDescription ( RID_SourceCOP source )

inline

◆ ~ResidueIndexDescription()

core::pose::ResidueIndexDescription::~ResidueIndexDescription ( )

overridedefault

Member Function Documentation

◆ do_error()

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

protected

Convenience function for triggering error conditions.

Referenced by core::pose::ResidueIndexDescriptionPoseNum::resolve_index(), core::pose::ResidueIndexDescriptionPDB::resolve_index(), and core::pose::ResidueIndexDescriptionChainEnd::resolve_index().

◆ get_source()

RID_SourceCOP core::pose::ResidueIndexDescription::get_source ( ) const

inline

References source_.

◆ resolve_index()

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.