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

#include <ResidueIndexDescription.hh>

Inheritance diagram for core::pose::ResidueIndexDescriptionRefPose:

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

◆ ResidueIndexDescriptionRefPose() [1/2]

core::pose::ResidueIndexDescriptionRefPose::ResidueIndexDescriptionRefPose	(	std::string const &	refpose_name,
		core::Size	refpose_number,
		signed long	refpose_offset
	)

inline

◆ ResidueIndexDescriptionRefPose() [2/2]

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

inline

◆ ~ResidueIndexDescriptionRefPose()

core::pose::ResidueIndexDescriptionRefPose::~ResidueIndexDescriptionRefPose ( )

overridedefault

Member Function Documentation

◆ refpose_name()

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

inline

References refpose_name_.

◆ refpose_number()

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

inline

References refpose_number_.

◆ refpose_offset()

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

inline

References refpose_offset_.

◆ resolve_index()

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_.