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

Search Toolkit Book for MoleculeIdentifier

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

+ Collaboration diagram for MoleculeIdentifier:

Public Types

typedef std::list< ncbi::CRef< ncbi::objects::CSeq_id > > SeqIdList
 

Public Member Functions

std::string ToString (void) const
 
bool MatchesSeqId (const ncbi::objects::CSeq_id &sid) const
 
bool HasStructure (void) const
 
std::string GetLabel (void) const
 

Static Public Member Functions

static const MoleculeIdentifierGetIdentifier (const Molecule *molecule, const SeqIdList &ids)
 
static const MoleculeIdentifierGetIdentifier (const Sequence *sequence, int mmdbID, const SeqIdList &ids)
 
static const MoleculeIdentifierFindIdentifier (int mmdbID, int moleculeID)
 
static void ClearIdentifiers (void)
 
static bool CompareIdentifiers (const MoleculeIdentifier *a, const MoleculeIdentifier *b)
 

Public Attributes

SeqIdList seqIDs
 
int mmdbID
 
int moleculeID
 
int pdbChain
 
int gi
 
std::string pdbID
 
unsigned int nResidues
 

Static Public Attributes

static const int VALUE_NOT_SET = -1
 

Private Member Functions

 MoleculeIdentifier (void)
 
void AddFields (const SeqIdList &ids)
 

Static Private Member Functions

static MoleculeIdentifierGetIdentifier (const SeqIdList &ids)
 
static MoleculeIdentifierGetIdentifier (int mmdbID, int moleculeID)
 

Detailed Description

Definition at line 51 of file molecule_identifier.hpp.

Member Typedef Documentation

typedef std::list< ncbi::CRef < ncbi::objects::CSeq_id > > MoleculeIdentifier::SeqIdList

Definition at line 57 of file molecule_identifier.hpp.

Constructor & Destructor Documentation

MoleculeIdentifier::MoleculeIdentifier ( void  )
inlineprivate

Definition at line 103 of file molecule_identifier.hpp.

Referenced by GetIdentifier().

Member Function Documentation

void MoleculeIdentifier::AddFields ( const SeqIdList ids)
private

Definition at line 226 of file molecule_identifier.cpp.

References ERRORMSG, NStr::Find(), gi, isalnum(), n, ne(), NPOS, pdbChain, pdbID, seqIDs, and VALUE_NOT_SET.

Referenced by GetIdentifier().

void MoleculeIdentifier::ClearIdentifiers ( void  )
static

Definition at line 284 of file molecule_identifier.cpp.

References knownIdentifiers.

Referenced by StructureSet::~StructureSet().

bool MoleculeIdentifier::CompareIdentifiers ( const MoleculeIdentifier a,
const MoleculeIdentifier b 
)
static
const MoleculeIdentifier * MoleculeIdentifier::FindIdentifier ( int  mmdbID,
int  moleculeID 
)
static

Definition at line 271 of file molecule_identifier.cpp.

References i, knownIdentifiers, and NULL.

Referenced by ExtractObjectLocation().

const MoleculeIdentifier * MoleculeIdentifier::GetIdentifier ( const Molecule molecule,
const SeqIdList ids 
)
static
const MoleculeIdentifier * MoleculeIdentifier::GetIdentifier ( const Sequence sequence,
int  mmdbID,
const SeqIdList ids 
)
static
MoleculeIdentifier * MoleculeIdentifier::GetIdentifier ( const SeqIdList ids)
staticprivate
MoleculeIdentifier * MoleculeIdentifier::GetIdentifier ( int  mmdbID,
int  moleculeID 
)
staticprivate

Definition at line 209 of file molecule_identifier.cpp.

References knownIdentifiers, mmdbID, moleculeID, and MoleculeIdentifier().

std::string MoleculeIdentifier::GetLabel ( void  ) const
inline

Definition at line 93 of file molecule_identifier.hpp.

References eContent, and string.

Referenced by DumpText(), and Sequence::LaunchWebBrowserWithInfo().

bool MoleculeIdentifier::HasStructure ( void  ) const
inline
bool MoleculeIdentifier::MatchesSeqId ( const ncbi::objects::CSeq_id &  sid) const
string MoleculeIdentifier::ToString ( void  ) const

Member Data Documentation

int MoleculeIdentifier::gi
int MoleculeIdentifier::mmdbID
int MoleculeIdentifier::moleculeID
unsigned int MoleculeIdentifier::nResidues
int MoleculeIdentifier::pdbChain
std::string MoleculeIdentifier::pdbID
SeqIdList MoleculeIdentifier::seqIDs

Definition at line 58 of file molecule_identifier.hpp.

Referenced by AddFields(), CompareIdentifiers(), MatchesSeqId(), and ToString().

const int MoleculeIdentifier::VALUE_NOT_SET = -1
static

The documentation for this class was generated from the following files:
Modified on Sat Aug 27 15:44:51 2016 by modify_doxy.py rev. 506947