core::id::NamedAtomID Class Reference

Atom identifier class. More...

#include <NamedAtomID.hh>

Public Member Functions
	NamedAtomID ()
	Default constructor. More...
	NamedAtomID (NamedAtomID const &)=default
	Copy constructor. More...
NamedAtomID &	operator= (NamedAtomID const &)=default
	Assignment operator. More...
template<class T , typename = typename std::enable_if< utility::type_traits::is_string_constructible<T>::value >::type>
	NamedAtomID (T &&atom_in, Size const rsd_in)
	NamedAtomID (std::string const &atom_in, Size const rsd_in)
Size	rsd () const
Size &	rsd ()
std::string const &	atom () const
std::string &	atom ()
bool	valid () const
	Is this id valid? More...
std::string	to_string () const

Static Public Member Functions
static NamedAtomID const	BOGUS_NAMED_ATOM_ID ()
static NamedAtomID const	CHAINBREAK_BOGUS_NAMED_ATOM_ID ()

Private Attributes
std::string	atom_
	Atom number within the Residue. More...
Size	rsd_
	Residue number within the complex. More...

Friends
std::ostream &	operator<< (std::ostream &os, NamedAtomID const &a)
	stream << NamedAtomID More...
std::istream &	operator>> (std::istream &is, NamedAtomID &e)
	input operator More...
bool	operator== (NamedAtomID const &a, NamedAtomID const &b)
	a and b are the same atom More...
bool	operator!= (NamedAtomID const &a, NamedAtomID const &b)
	a and b are different atom More...
bool	operator< (NamedAtomID const &a, NamedAtomID const &b)
	a is LOWER than b (e.g., first by smaller residue index number then by smaller atom index number) More...

Detailed Description

Atom identifier class.

Constructor & Destructor Documentation

NamedAtomID() [1/4]

core::id::NamedAtomID::NamedAtomID ( )

inline

Default constructor.

Referenced by BOGUS_NAMED_ATOM_ID(), and CHAINBREAK_BOGUS_NAMED_ATOM_ID().

NamedAtomID() [2/4]

core::id::NamedAtomID::NamedAtomID ( NamedAtomID const &  )

inlinedefault

Copy constructor.

NamedAtomID() [3/4]

template<class T , typename = typename std::enable_if< utility::type_traits::is_string_constructible<T>::value >::type>

core::id::NamedAtomID::NamedAtomID ( T &&  atom_in, Size const  rsd_in  )

inline

NamedAtomID() [4/4]

core::id::NamedAtomID::NamedAtomID ( std::string const &  atom_in, Size const  rsd_in  )

inline

Member Function Documentation

atom() [1/2]

std::string& core::id::NamedAtomID::atom ( )

inline

References atom_.

atom() [2/2]

std::string const& core::id::NamedAtomID::atom ( ) const

inline

References atom_.

Referenced by protocols::noesy_assign::Resonance::_write_to_stream(), core::scoring::constraints::AmbiguousNMRDistanceConstraint::AmbiguousNMRDistanceConstraint(), core::conformation::Conformation::append_residue(), protocols::noesy_assign::PeakCalibrator::atom_type(), core::scoring::constraints::NamedAngleConstraint::dist(), core::scoring::constraints::NamedDihedralConstraint::dist(), protocols::noesy_assign::fall_back(), core::scoring::constraints::Obsolet_NamedAtomPairConstraint::mapto(), protocols::noesy_assign::Resonance::name(), core::pose::named_atom_id_to_atom_id(), core::conformation::named_atom_id_to_atom_id(), core::id::NamedStubID::NamedStubID(), core::scoring::constraints::NamedAngleConstraint::remap_resid(), core::scoring::constraints::NamedAtomPairConstraint::remap_resid(), core::scoring::constraints::NamedDihedralConstraint::remap_resid(), core::conformation::Conformation::residues_append(), core::scoring::constraints::NamedAngleConstraint::score(), core::scoring::constraints::NamedDihedralConstraint::score(), core::scoring::constraints::NamedAngleConstraint::setup_for_scoring(), core::scoring::constraints::NamedAtomPairConstraint::setup_for_scoring(), core::scoring::constraints::LocalCoordinateConstraint::show_def(), protocols::comparative_modeling::steal_ligands(), protocols::noesy_assign::sum_IntraNOE(), protocols::noesy_assign::FragsToAtomDist::swap_atoms(), to_string(), protocols::noesy_assign::PeakFileFormat_Sparky::write_assignment(), and protocols::noesy_assign::PeakFileFormat_xpk::write_assignment().

BOGUS_NAMED_ATOM_ID()

static NamedAtomID const core::id::NamedAtomID::BOGUS_NAMED_ATOM_ID ( )

inlinestatic

References NamedAtomID().

Referenced by core::conformation::Conformation::append_residue_by_bond(), core::conformation::Conformation::append_residue_by_jump(), core::conformation::Conformation::append_residues(), and core::conformation::Conformation::residues_append().

CHAINBREAK_BOGUS_NAMED_ATOM_ID()

static NamedAtomID const core::id::NamedAtomID::CHAINBREAK_BOGUS_NAMED_ATOM_ID ( )

inlinestatic

References NamedAtomID().

operator=()

NamedAtomID& core::id::NamedAtomID::operator= ( NamedAtomID const &  )

inlinedefault

Assignment operator.

rsd() [1/2]

Size& core::id::NamedAtomID::rsd ( )

inline

References rsd_.

rsd() [2/2]

Size core::id::NamedAtomID::rsd ( ) const

inline

References rsd_.

Referenced by protocols::noesy_assign::Resonance::_write_to_stream(), core::scoring::constraints::AmbiguousNMRDistanceConstraint::AmbiguousNMRDistanceConstraint(), core::conformation::Conformation::append_residue(), core::scoring::constraints::NamedAngleConstraint::dist(), core::scoring::constraints::NamedDihedralConstraint::dist(), protocols::noesy_assign::fall_back(), protocols::noesy_assign::CrossPeakList::generate_fa_and_cen_constraints(), core::scoring::constraints::Obsolet_NamedAtomPairConstraint::mapto(), core::pose::named_atom_id_to_atom_id(), core::conformation::named_atom_id_to_atom_id(), core::id::NamedStubID::NamedStubID(), protocols::noesy_assign::PeakAssignmentResidueMap::network_analysis(), protocols::noesy_assign::ResonanceList::operator[](), core::scoring::constraints::NamedAngleConstraint::remap_resid(), core::scoring::constraints::NamedAtomPairConstraint::remap_resid(), core::scoring::constraints::NamedDihedralConstraint::remap_resid(), protocols::constraints_additional::COMCoordinateConstraint::remapped_clone(), core::scoring::constraints::AtomToAxisConstraint::remapped_clone(), core::scoring::constraints::CoordinateConstraint::remapped_clone(), core::scoring::constraints::DihedralConstraint::remapped_clone(), core::scoring::constraints::DihedralPairConstraint::remapped_clone(), core::scoring::constraints::DistancePairConstraint::remapped_clone(), core::scoring::constraints::LocalCoordinateConstraint::remapped_clone(), core::scoring::constraints::NamedAtomPairConstraint::remapped_clone(), core::scoring::constraints::NamedDihedralConstraint::remapped_clone(), core::scoring::constraints::RTConstraint::remapped_clone(), protocols::noesy_assign::Resonance::resid(), core::conformation::Conformation::residues_append(), core::scoring::constraints::NamedAngleConstraint::score(), core::scoring::constraints::NamedDihedralConstraint::score(), core::scoring::constraints::NamedAngleConstraint::setup_for_scoring(), core::scoring::constraints::NamedAtomPairConstraint::setup_for_scoring(), core::scoring::constraints::LocalCoordinateConstraint::show_def(), protocols::comparative_modeling::steal_ligands(), protocols::noesy_assign::FragsToAtomDist::swap_atoms(), to_string(), valid(), protocols::noesy_assign::PeakFileFormat_Sparky::write_assignment(), and protocols::noesy_assign::PeakFileFormat_xpk::write_assignment().

to_string()

std::string core::id::NamedAtomID::to_string

(

)

const

References atom(), and rsd().

Referenced by protocols::noesy_assign::EXCN_UnknownResonance::EXCN_UnknownResonance().

valid()

bool core::id::NamedAtomID::valid ( ) const

inline

Is this id valid?

Note

Must return false for BOGUS_ATOM_ID

References atom_, and rsd().

Referenced by core::scoring::constraints::Obsolet_NamedAtomPairConstraint::mapto(), core::pose::named_atom_id_to_atom_id(), core::conformation::named_stub_id_to_stub_id(), core::pose::named_stub_id_to_stub_id(), protocols::comparative_modeling::steal_ligands(), and core::id::NamedStubID::valid().

Friends And Related Function Documentation

operator!=

bool operator!= ( NamedAtomID const &  a, NamedAtomID const &  b  )

friend

a and b are different atom

operator<

bool operator< ( NamedAtomID const &  a, NamedAtomID const &  b  )

friend

a is LOWER than b (e.g., first by smaller residue index number then by smaller atom index number)

operator<<

std::ostream& operator<< ( std::ostream &  os, NamedAtomID const &  a  )

friend

stream << NamedAtomID

operator==

bool operator== ( NamedAtomID const &  a, NamedAtomID const &  b  )

friend

a and b are the same atom

operator>>

std::istream& operator>> ( std::istream &  is, NamedAtomID &  e  )

friend

input operator

Member Data Documentation

atom_

std::string core::id::NamedAtomID::atom_

private

Atom number within the Residue.

Referenced by atom(), and valid().

rsd_

Size core::id::NamedAtomID::rsd_

private

Residue number within the complex.

Referenced by rsd().

---

The documentation for this class was generated from the following files:

• src/core/id/NamedAtomID.hh
• src/core/id/NamedAtomID.cc