ResidueIndexDescription.hh File Reference

Classes designed to hold data neceassary to describe a residue in a Pose, which may come from a text file, e.g., and to resolve that data into an actual residue index when a Pose becomes available (which is likely not at the time that the file is read) and to throw an exception if the index cannot be resolved. More...

#include <core/pose/ResidueIndexDescription.fwd.hh>
#include <core/types.hh>
#include <core/pose/Pose.fwd.hh>
#include <utility/VirtualBase.hh>
#include <string>
#include <iosfwd>

Classes
class	core::pose::RID_Source
	A class to hold information about where a ResidueIndexDescriptor comes from, to allow for better error messages. More...
class	core::pose::RID_FileSource
	Representation of a file input support A class to hold information about where a ResidueIndexDescriptor comes from, to allow for better error messages. More...
class	core::pose::ResidueIndexDescription
	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...
class	core::pose::ResidueIndexDescriptionPoseNum
	a class which represents a residue index as a literal, Rosetta/Pose numbered integer More...
class	core::pose::ResidueIndexDescriptionPDB
	a class which represents a residue index as a PDB information (chain, resindex, insertion code) More...
class	core::pose::ResidueIndexDescriptionRefPose
	a class which represents a residue index as a reference-pose enabled information. More...
class	core::pose::ResidueIndexDescriptionLastResidue
	a class which represents the last residue in the Pose More...
class	core::pose::ResidueIndexDescriptionChainEnd
	a class which represents the last residue in the Pose More...

Namespaces
	core
	A class for reading in the atom type properties.
	core::pose

Functions
std::ostream &	core::pose::operator<< (std::ostream &out, ResidueIndexDescription const &rid)
ResidueIndexDescriptionCOP	core::pose::make_rid_posenum (core::Size resnum)
	Convenience function for converting a Size (Pose numbered) into a ResidueIndexDescription. More...
void	core::pose::parse_PDBnum_icode (std::string const &token, std::string const &fname, Size const lineno, int &PDBnum, char &icode)
	Take the string "token" and try to interpret it as a PDB identifier in the form of an integer as well as an optional insertion code. For example the string "25A" would be interpretted as the residue 25 with the insertion code "A." Throws an exception if the input string is misformatted. More...

Detailed Description

Classes designed to hold data neceassary to describe a residue in a Pose, which may come from a text file, e.g., and to resolve that data into an actual residue index when a Pose becomes available (which is likely not at the time that the file is read) and to throw an exception if the index cannot be resolved.

Author

Brian D. Weitzner

Andrew Leaver-Fay (aleav.nosp@m.erfa.nosp@m.y@gma.nosp@m.il.c.nosp@m.om)

Rocco Moretti (rmore.nosp@m.ttia.nosp@m.se@gm.nosp@m.ail..nosp@m.com)