residue.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:7k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: residue.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:33:17  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.20
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: residue.hpp,v 1000.1 2004/04/12 17:33:17 gouriano Exp $
  10. * ===========================================================================
  11. *
  12. *                            PUBLIC DOMAIN NOTICE
  13. *               National Center for Biotechnology Information
  14. *
  15. *  This software/database is a "United States Government Work" under the
  16. *  terms of the United States Copyright Act.  It was written as part of
  17. *  the author's official duties as a United States Government employee and
  18. *  thus cannot be copyrighted.  This software/database is freely available
  19. *  to the public for use. The National Library of Medicine and the U.S.
  20. *  Government have not placed any restriction on its use or reproduction.
  21. *
  22. *  Although all reasonable efforts have been taken to ensure the accuracy
  23. *  and reliability of the software and data, the NLM and the U.S.
  24. *  Government do not and cannot warrant the performance or results that
  25. *  may be obtained by using this software or data. The NLM and the U.S.
  26. *  Government disclaim all warranties, express or implied, including
  27. *  warranties of performance, merchantability or fitness for any particular
  28. *  purpose.
  29. *
  30. *  Please cite the author in any work or product based on this material.
  31. *
  32. * ===========================================================================
  33. *
  34. * Authors:  Paul Thiessen
  35. *
  36. * File Description:
  37. *      Classes to hold residues
  38. *
  39. * ===========================================================================
  40. */
  41. #ifndef CN3D_RESIDUE__HPP
  42. #define CN3D_RESIDUE__HPP
  43. #include <corelib/ncbistl.hpp>
  44. #include <map>
  45. #include <string>
  46. #include <objects/mmdb1/Residue_graph.hpp>
  47. #include <objects/mmdb1/Residue.hpp>
  48. #include "structure_base.hpp"
  49. BEGIN_SCOPE(Cn3D)
  50. typedef std::list< ncbi::CRef< ncbi::objects::CResidue_graph > > ResidueGraphList;
  51. // a Residue is a set of bonds that connect one residue of a larger Molecule.
  52. // Its constructor is where most of the work of decoding the ASN1 graph is done,
  53. // based on the standard and local residue dictionaries. Each Residue also holds
  54. // information (AtomInfo) about the nature of the atoms it contains.
  55. class Bond;
  56. class Residue : public StructureBase
  57. {
  58. public:
  59.     Residue(StructureBase *parent,
  60.         const ncbi::objects::CResidue& residue, int moleculeID,
  61.         const ResidueGraphList& standardDictionary,
  62.         const ResidueGraphList& localDictionary);
  63.     ~Residue(void);
  64.     // public data
  65.     int id;
  66.     static const char NO_CODE;
  67.     char code;
  68.     std::string
  69.         nameGraph,  // 'name' field from residue-graph dictionary
  70.         namePDB;    // 'name' in Residue, supposed to correspond to PDB-assigned residue number
  71.     static const int NO_ALPHA_ID;
  72.     int alphaID; // ID of "alpha" atom (C-alpha or P)
  73.     // residue type
  74.     enum eType {
  75.         eDNA = ncbi::objects::CResidue_graph::eResidue_type_deoxyribonucleotide,
  76.         eRNA = ncbi::objects::CResidue_graph::eResidue_type_ribonucleotide,
  77.         eAminoAcid = ncbi::objects::CResidue_graph::eResidue_type_amino_acid,
  78.         eOther = ncbi::objects::CResidue_graph::eResidue_type_other
  79.     };
  80.     eType type;
  81.     // atom type
  82.     enum eAtomClassification {
  83.         eSideChainAtom,
  84.         eAlphaBackboneAtom,     // C-alpha or P
  85.         ePartialBackboneAtom,   // for unbranched backbone trace
  86.         eCompleteBackboneAtom,  // all backbone atoms
  87.         eUnknownAtom            // anything that's not known to be of an amino acid or nucleotide
  88.     };
  89.     typedef struct {
  90.         std::string name, code;
  91.         int atomicNumber;
  92.         eAtomClassification classification;
  93.         unsigned int glName;
  94.         const Residue *residue;  // convenient way to go from atom->residue
  95.         bool isIonizableProton;
  96.     } AtomInfo;
  97.     typedef std::list < const Bond * > BondList;
  98.     BondList bonds;
  99.     // public methods
  100.     bool HasCode(void) const { return (code != NO_CODE); }
  101.     bool HasName(void) const { return (!nameGraph.empty()); }
  102.     bool IsNucleotide(void) const { return (type == eDNA || type == eRNA); }
  103.     bool IsAminoAcid(void) const { return (type == eAminoAcid); }
  104.     bool Draw(const AtomSet *atomSet) const;
  105.     typedef std::map < int , const AtomInfo * > AtomInfoMap;
  106. private:
  107.     AtomInfoMap atomInfos;  // mapped by Atom-id
  108.     int nAtomsWithAnyCoords;
  109. public:
  110.     // # atoms in the graph for this residue
  111.     int NAtomsInGraph(void) const { return atomInfos.size(); }
  112.     // # atoms in this residue with real coordinates in any model
  113.     int NAtomsWithAnyCoords(void) const { return nAtomsWithAnyCoords; }
  114.     const AtomInfoMap& GetAtomInfos(void) const { return atomInfos; }
  115.     const AtomInfo * GetAtomInfo(int aID) const
  116.     {
  117.         AtomInfoMap::const_iterator info=atomInfos.find(aID);
  118.         if (info != atomInfos.end()) return (*info).second;
  119.         ERR_POST(ncbi::Warning << "Residue #" << id << ": can't find atom #" << aID);
  120.         return NULL;
  121.     }
  122. };
  123. END_SCOPE(Cn3D)
  124. #endif // CN3D_RESIDUE__HPP
  125. /*
  126. * ---------------------------------------------------------------------------
  127. * $Log: residue.hpp,v $
  128. * Revision 1000.1  2004/04/12 17:33:17  gouriano
  129. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.20
  130. *
  131. * Revision 1.20  2004/02/19 17:05:05  thiessen
  132. * remove cn3d/ from include paths; add pragma to disable annoying msvc warning
  133. *
  134. * Revision 1.19  2003/06/21 08:18:58  thiessen
  135. * show all atoms with coordinates, even if not in all coord sets
  136. *
  137. * Revision 1.18  2003/02/03 19:20:05  thiessen
  138. * format changes: move CVS Log to bottom of file, remove std:: from .cpp files, and use new diagnostic macros
  139. *
  140. * Revision 1.17  2001/05/31 18:46:27  thiessen
  141. * add preliminary style dialog; remove LIST_TYPE; add thread single and delete all; misc tweaks
  142. *
  143. * Revision 1.16  2001/05/15 23:49:20  thiessen
  144. * minor adjustments to compile under Solaris/wxGTK
  145. *
  146. * Revision 1.15  2001/04/18 15:46:32  thiessen
  147. * show description, length, and PDB numbering in status line
  148. *
  149. * Revision 1.14  2001/03/28 23:01:38  thiessen
  150. * first working full threading
  151. *
  152. * Revision 1.13  2001/03/23 23:31:30  thiessen
  153. * keep atom info around even if coords not all present; mainly for disulfide parsing in virtual models
  154. *
  155. * Revision 1.12  2000/10/04 17:40:46  thiessen
  156. * rearrange STL #includes
  157. *
  158. * Revision 1.11  2000/08/30 19:49:04  thiessen
  159. * working sequence window
  160. *
  161. * Revision 1.10  2000/08/24 18:43:15  thiessen
  162. * tweaks for transparent sphere display
  163. *
  164. * Revision 1.9  2000/08/17 14:22:00  thiessen
  165. * added working StyleManager
  166. *
  167. * Revision 1.8  2000/08/11 12:59:13  thiessen
  168. * added worm; get 3d-object coords from asn1
  169. *
  170. * Revision 1.7  2000/08/04 22:49:11  thiessen
  171. * add backbone atom classification and selection feedback mechanism
  172. *
  173. * Revision 1.6  2000/08/03 15:12:29  thiessen
  174. * add skeleton of style and show/hide managers
  175. *
  176. * Revision 1.5  2000/07/27 13:30:10  thiessen
  177. * remove 'using namespace ...' from all headers
  178. *
  179. * Revision 1.4  2000/07/17 11:58:58  thiessen
  180. * fix nucleotide virtual bonds
  181. *
  182. * Revision 1.3  2000/07/17 04:21:10  thiessen
  183. * now does correct structure alignment transformation
  184. *
  185. * Revision 1.2  2000/07/16 23:18:34  thiessen
  186. * redo of drawing system
  187. *
  188. * Revision 1.1  2000/07/11 13:49:29  thiessen
  189. * add modules to parse chemical graph; many improvements
  190. *
  191. */