Rosetta Core  2014.35
Public Member Functions | Private Attributes | Friends | List of all members
core::id::NamedAtomID Class Reference

Atom identifier class. More...

#include <NamedAtomID.hh>

Public Member Functions

 NamedAtomID ()
 Default constructor. More...
 
 NamedAtomID (NamedAtomID const &src)
 Copy constructor. More...
 
 NamedAtomID (std::string const &atom_in, Size const rsd_in)
 Property constructor. More...
 
Size rsd () const
 
Sizersd ()
 
std::string const & atom () const
 
std::string & atom ()
 
bool valid () const
 Is this id valid? More...
 
std::string to_string () const
 

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

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

Default constructor.

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

Copy constructor.

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

Property constructor.

Member Function Documentation

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

References atom_.

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

References rsd_.

std::string core::id::NamedAtomID::to_string ( ) const

References atom(), and rsd().

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

Friends And Related Function Documentation

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

a and b are different atom

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)

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

stream << NamedAtomID

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

a and b are the same atom

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

input operator

Member Data Documentation

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

Atom number within the Residue.

Referenced by atom(), and valid().

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: