UniqueAtomIdentifier Class Reference

Contains the infomation needed to uniquely identify an atom in a structure. More...

#include <distance_test_common.hh>

Public Member Functions

 UniqueAtomIdentifier (const String &chain, const ResNum &residue, const String &residue_name, const String &atom)
 UniqueAtomIdentifier ()
String GetChainName () const
ResNum GetResNum () const
String GetResidueName () const
String GetAtomName () const
String GetQualifiedAtomName () const
bool operator== (const UniqueAtomIdentifier &rhs) const
bool operator< (const UniqueAtomIdentifier &rhs) const

Detailed Description

Contains the infomation needed to uniquely identify an atom in a structure.

Used by the the Local Distance Difference Test classes and functions

Definition at line 43 of file distance_test_common.hh.


Constructor & Destructor Documentation

UniqueAtomIdentifier ( const String chain,
const ResNum residue,
const String residue_name,
const String atom 
) [inline]

Constructor with all the relevant information.

Definition at line 48 of file distance_test_common.hh.

UniqueAtomIdentifier (  )  [inline]

Definition at line 51 of file distance_test_common.hh.


Member Function Documentation

String GetAtomName (  )  const [inline]

Returns the name of the atom, as a String.

Definition at line 63 of file distance_test_common.hh.

String GetChainName (  )  const [inline]

Returns the name of the chain to which the atom belongs, as a String.

Definition at line 54 of file distance_test_common.hh.

String GetQualifiedAtomName (  )  const

Returns the qualified name of the atom, as a String.

String GetResidueName (  )  const [inline]

Returns the name of the residue to which the atom belongs, as a String.

Definition at line 60 of file distance_test_common.hh.

ResNum GetResNum (  )  const [inline]

Returns the ResNum of the residue to which the atom belongs.

Definition at line 57 of file distance_test_common.hh.

bool operator< ( const UniqueAtomIdentifier rhs  )  const
bool operator== ( const UniqueAtomIdentifier rhs  )  const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated on 1 Mar 2018 for OpenStructure by  doxygen 1.6.1