OpenStructure
Public Member Functions
UniqueAtomIdentifier Class Reference

#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() [1/2]

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() [2/2]

Definition at line 51 of file distance_test_common.hh.

Member Function Documentation

◆ GetAtomName()

String GetAtomName ( ) const
inline

Returns the name of the atom, as a String.

Definition at line 63 of file distance_test_common.hh.

◆ GetChainName()

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.

◆ GetQualifiedAtomName()

String GetQualifiedAtomName ( ) const

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

◆ GetResidueName()

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.

◆ GetResNum()

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.

◆ operator<()

bool operator< ( const UniqueAtomIdentifier rhs) const

◆ operator==()

bool operator== ( const UniqueAtomIdentifier rhs) const

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