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

#include <ResidueIndexDescription.hh>

Inheritance diagram for core::pose::ResidueIndexDescriptionChainEnd:

Public Member Functions
	ResidueIndexDescriptionChainEnd (char chain, bool chain_start=false)

	ResidueIndexDescriptionChainEnd (RID_SourceCOP source, char chain, bool chain_start=false)

	ResidueIndexDescriptionChainEnd (core::Size chain, bool chain_start=false)

	ResidueIndexDescriptionChainEnd (RID_SourceCOP source, core::Size chain, bool chain_start=false)

	~ResidueIndexDescriptionChainEnd () 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

Private Attributes
bool	chain_start_ = false
	Should it be the front end of the chain we return? More...

signed int	chain_no_ = -1
	The chain number to use. If equal to -1, use chain letter instead. More...

char	chain_letter_ = 0x00
	If valid (non-null), identify chain by letter. More...

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

◆ ResidueIndexDescriptionChainEnd() [1/4]

core::pose::ResidueIndexDescriptionChainEnd::ResidueIndexDescriptionChainEnd	(	char	chain,
		bool	chain_start = `false`
	)

inline

◆ ResidueIndexDescriptionChainEnd() [2/4]

core::pose::ResidueIndexDescriptionChainEnd::ResidueIndexDescriptionChainEnd	(	RID_SourceCOP	source,
		char	chain,
		bool	chain_start = `false`
	)

inline

◆ ResidueIndexDescriptionChainEnd() [3/4]

core::pose::ResidueIndexDescriptionChainEnd::ResidueIndexDescriptionChainEnd	(	core::Size	chain,
		bool	chain_start = `false`
	)

inline

◆ ResidueIndexDescriptionChainEnd() [4/4]

core::pose::ResidueIndexDescriptionChainEnd::ResidueIndexDescriptionChainEnd	(	RID_SourceCOP	source,
		core::Size	chain,
		bool	chain_start = `false`
	)

inline

◆ ~ResidueIndexDescriptionChainEnd()

core::pose::ResidueIndexDescriptionChainEnd::~ResidueIndexDescriptionChainEnd ( )

overridedefault

Member Function Documentation

◆ resolve_index()

core::Size core::pose::ResidueIndexDescriptionChainEnd::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::conformation::Conformation::chain_begin(), core::conformation::Conformation::chain_end(), chain_letter_, chain_no_, chain_start_, core::pose::Pose::conformation(), core::pose::ResidueIndexDescription::do_error(), core::pose::get_chain_ids_from_chain(), core::pose::Pose::num_chains(), core::pose::ResidueIndexDescription::source_string(), and core::id::to_string().