NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Private Attributes | List of all members
Residue Class Reference

Search Toolkit Book for Residue

#include "residue.hpp"
(Private to src/app/cn3d.)

+ Inheritance diagram for Residue:
+ Collaboration diagram for Residue:


struct  AtomInfo

Public Types

enum  eType { eDNA = ncbi::objects::CResidue_graph::eResidue_type_deoxyribonucleotide , eRNA = ncbi::objects::CResidue_graph::eResidue_type_ribonucleotide , eAminoAcid = ncbi::objects::CResidue_graph::eResidue_type_amino_acid , eOther = ncbi::objects::CResidue_graph::eResidue_type_other }
enum  eAtomClassification {
  eSideChainAtom , eAlphaBackboneAtom , ePartialBackboneAtom , eCompleteBackboneAtom ,
typedef std::list< const Bond * > BondList
typedef std::map< int, const AtomInfo * > AtomInfoMap

Public Member Functions

 Residue (StructureBase *parent, const ncbi::objects::CResidue &residue, int moleculeID, const ResidueGraphList &standardDictionary, const ResidueGraphList &localDictionary, int nResidues, int moleculeType)
 ~Residue (void)
bool HasCode (void) const
bool HasName (void) const
bool IsNucleotide (void) const
bool IsAminoAcid (void) const
bool Draw (const AtomSet *atomSet) const
int NAtomsInGraph (void) const
int NAtomsWithAnyCoords (void) const
const AtomInfoMapGetAtomInfos (void) const
const AtomInfoGetAtomInfo (int aID) const
- Public Member Functions inherited from StructureBase
 StructureBase (StructureBase *parent)
virtual ~StructureBase (void)
virtual bool DrawAll (const AtomSet *atomSet=NULL) const
template<class T >
bool GetParentOfType (const T **ptr, bool warnIfNotFound=true) const

Public Attributes

int id
char code
std::string nameGraph
std::string namePDB
int alphaID
eType type
BondList bonds
- Public Attributes inherited from StructureBase

Static Public Attributes

static const char NO_CODE = '?'
static const int NO_ALPHA_ID = -1

Private Attributes

AtomInfoMap atomInfos
int nAtomsWithAnyCoords

Detailed Description

Definition at line 58 of file residue.hpp.

Member Typedef Documentation

◆ AtomInfoMap

typedef std::map< int , const AtomInfo * > Residue::AtomInfoMap

Definition at line 115 of file residue.hpp.

◆ BondList

typedef std::list< const Bond * > Residue::BondList

Definition at line 105 of file residue.hpp.

Member Enumeration Documentation

◆ eAtomClassification


Definition at line 88 of file residue.hpp.

◆ eType


Definition at line 79 of file residue.hpp.

Constructor & Destructor Documentation

◆ Residue()

Residue::Residue ( StructureBase parent,
const ncbi::objects::CResidue &  residue,
int  moleculeID,
const ResidueGraphList standardDictionary,
const ResidueGraphList localDictionary,
int  nResidues,
int  moleculeType 

Definition at line 140 of file residue.cpp.

References a, alphaID, atomInfos, b, bonds, ClassifyAtom(), StructureObject::coordSets, StructureSet::CreateName(), eAlphaBackboneAtom, CAtom_Base::eIonizable_proton_true, Molecule::eNonpolymer, Molecule::eOther, ERRORMSG, Molecule::eSolvent, Bond::eUnknown, CAliasBase< TPrim >::Get(), CResidue_graph_Base::GetAtoms(), CBiostruc_residue_graph_set_pntr_Base::GetBiostruc_residue_graph_set_id(), CResidue_graph_Base::GetBonds(), CDbtag_Base::GetDb(), CResidue_graph_Base::GetDescr(), CAtom_Base::GetElement(), CObject_id_Base::GetId(), CAtom_Base::GetId(), CResidue_Base::GetId(), CAtom_Base::GetIonizable_proton(), CAtom_Base::GetIupac_code(), CResidue_graph_Base::GetIupac_code(), CResidue_graph_pntr_Base::GetLocal(), CAtom_Base::GetName(), CResidue_Base::GetName(), CBiostruc_id_Base::GetOther_database(), StructureBase::GetParentOfType(), CResidue_Base::GetResidue_graph(), CBiostruc_residue_graph_set_pntr_Base::GetResidue_graph_id(), CResidue_graph_Base::GetResidue_type(), CResidue_graph_pntr_Base::GetStandard(), CDbtag_Base::GetTag(), i, info, CObject_id_Base::IsId(), CResidue_graph_pntr_Base::IsLocal(), CBiostruc_id_Base::IsOther_database(), CResidue_graph_Base::IsSetDescr(), CAtom_Base::IsSetIonizable_proton(), CAtom_Base::IsSetIupac_code(), CResidue_graph_Base::IsSetIupac_code(), CAtom_Base::IsSetName(), CResidue_Base::IsSetName(), CResidue_graph_Base::IsSetResidue_type(), CResidue_graph_pntr_Base::IsStandard(), MakeBond(), nameGraph, namePDB, nAtomsWithAnyCoords, NULL, StructureBase::parentSet, and standardDictionary.

◆ ~Residue()

Residue::~Residue ( void  )

Definition at line 272 of file residue.cpp.

References a, and atomInfos.

Member Function Documentation

◆ Draw()

bool Residue::Draw ( const AtomSet atomSet) const

◆ GetAtomInfo()

const AtomInfo* Residue::GetAtomInfo ( int  aID) const

Definition at line 128 of file residue.hpp.

References ERR_POST, info, NULL, and Warning().

Referenced by StyleManager::GetAtomStyle(), and StructureSet::SelectedAtom().

◆ GetAtomInfos()

const AtomInfoMap& Residue::GetAtomInfos ( void  ) const

Definition at line 127 of file residue.hpp.

Referenced by GetVirtualResidue().

◆ HasCode()

bool Residue::HasCode ( void  ) const

Definition at line 109 of file residue.hpp.

◆ HasName()

bool Residue::HasName ( void  ) const

Definition at line 110 of file residue.hpp.

◆ IsAminoAcid()

bool Residue::IsAminoAcid ( void  ) const

◆ IsNucleotide()

bool Residue::IsNucleotide ( void  ) const

Definition at line 111 of file residue.hpp.

References eRNA.

Referenced by ClassifyAtom(), Draw(), and StyleManager::GetAtomStyle().

◆ NAtomsInGraph()

int Residue::NAtomsInGraph ( void  ) const

Definition at line 123 of file residue.hpp.

Referenced by StyleManager::GetAtomStyle().

◆ NAtomsWithAnyCoords()

int Residue::NAtomsWithAnyCoords ( void  ) const

Definition at line 125 of file residue.hpp.

Referenced by Molecule::Molecule().

Member Data Documentation

◆ alphaID

int Residue::alphaID

◆ atomInfos

AtomInfoMap Residue::atomInfos

Definition at line 118 of file residue.hpp.

Referenced by Draw(), Residue(), and ~Residue().

◆ bonds

BondList Residue::bonds

Definition at line 106 of file residue.hpp.

Referenced by Residue().

◆ code

char Residue::code

Definition at line 71 of file residue.hpp.

Referenced by Draw(), and StyleManager::GetAtomStyle().

◆ id

int Residue::id

◆ nameGraph

std::string Residue::nameGraph

Definition at line 73 of file residue.hpp.

Referenced by Draw(), StyleManager::GetBondStyle(), Residue(), and StructureSet::SelectedAtom().

◆ namePDB

std::string Residue::namePDB

Definition at line 74 of file residue.hpp.

Referenced by Draw(), SequenceDisplay::MouseOver(), Residue(), and StructureSet::SelectedAtom().

◆ nAtomsWithAnyCoords

int Residue::nAtomsWithAnyCoords

Definition at line 119 of file residue.hpp.

Referenced by Residue().


const int Residue::NO_ALPHA_ID = -1


const char Residue::NO_CODE = '?'

Definition at line 70 of file residue.hpp.

◆ type

eType Residue::type

Definition at line 85 of file residue.hpp.

The documentation for this class was generated from the following files:
Modified on Wed Dec 06 07:12:35 2023 by rev. 669887