a class which represents a residue index as a PDB information (chain, resindex, insertion code) More...

#include <ResidueIndexDescription.hh>

Inheritance diagram for core::pose::ResidueIndexDescriptionPDB:

Public Member Functions
	ResidueIndexDescriptionPDB (char chain, int resindex, char insertion_code=' ')

	ResidueIndexDescriptionPDB (RID_SourceCOP source, char chain, int resindex, char insertion_code=' ')

	~ResidueIndexDescriptionPDB () override

char	chain () const

int	resindex () const

char	insertion_code () 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
char	chain_

int	resindex_

char	insertion_code_

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 PDB information (chain, resindex, insertion code)

Constructor & Destructor Documentation

◆ ResidueIndexDescriptionPDB() [1/2]

core::pose::ResidueIndexDescriptionPDB::ResidueIndexDescriptionPDB	(	char	chain,
		int	resindex,
		char	insertion_code = `' '`
	)

inline

◆ ResidueIndexDescriptionPDB() [2/2]

core::pose::ResidueIndexDescriptionPDB::ResidueIndexDescriptionPDB	(	RID_SourceCOP	source,
		char	chain,
		int	resindex,
		char	insertion_code = `' '`
	)

inline

◆ ~ResidueIndexDescriptionPDB()

core::pose::ResidueIndexDescriptionPDB::~ResidueIndexDescriptionPDB ( )

overridedefault

Member Function Documentation

◆ chain()

char core::pose::ResidueIndexDescriptionPDB::chain ( ) const

inline

References chain_.

◆ insertion_code()

char core::pose::ResidueIndexDescriptionPDB::insertion_code ( ) const

inline

References insertion_code_.

◆ resindex()

int core::pose::ResidueIndexDescriptionPDB::resindex ( ) const

inline

References resindex_.

◆ resolve_index()

core::Size core::pose::ResidueIndexDescriptionPDB::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 chain_, core::pose::ResidueIndexDescription::do_error(), insertion_code_, core::pose::Pose::pdb_info(), resindex_, core::pose::ResidueIndexDescription::source_string(), and core::id::to_string().