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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: cn3d_cache.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:31:33  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.6
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: cn3d_cache.hpp,v 1000.1 2004/04/12 17:31:33 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. *      implements a basic cache for Biostrucs
  38. *
  39. * ===========================================================================
  40. */
  41. #ifndef CN3D_CACHE__HPP
  42. #define CN3D_CACHE__HPP
  43. #include <corelib/ncbistd.hpp>
  44. #include <string>
  45. #include <list>
  46. #include <objects/ncbimime/Ncbi_mime_asn1.hpp>
  47. #include <objects/mmdb1/Biostruc.hpp>
  48. #include <objects/mmdb2/Model_type.hpp>
  49. #include <objects/seq/Bioseq.hpp>
  50. BEGIN_SCOPE(Cn3D)
  51. // Retrieves a Biostruc from the cache, according to the cache configuration currently in the registry;
  52. // returns true on success or false if fetch fails for any reason. MMDB entries are cached according to
  53. // asn Model-type, so an ncbi-backbone and pdb-model for a given MMDB ID are cached independently.
  54. // If the cache is disabled, this will always attempt to load via network. (The contents of
  55. // the passed *biostruc are deleted and replaced by the fetched data.) modelType can be:
  56. //   eModel_type_ncbi_backbone (alpha only),
  57. //   eModel_type_ncbi_all_atom (one coordinate per atom),
  58. //   eModel_type_ncbi_pdb_model (all models from PDB, including alternate conformer ensembles)
  59. // If sequences is not NULL, the list will be filled with Bioseqs for all biopolymer chains
  60. // in the structure.
  61. typedef std::list < ncbi::CRef < ncbi::objects::CBioseq > > BioseqRefList;
  62. // uid can either be an integer MMDB ID or a 4-character PDB ID
  63. bool LoadStructureViaCache(const std::string& uid, ncbi::objects::EModel_type modelType,
  64.     ncbi::CRef < ncbi::objects::CBiostruc >& biostruc, BioseqRefList *sequences);
  65. ncbi::objects::CNcbi_mime_asn1 *
  66.     LoadStructureViaCache(const std::string& uid, ncbi::objects::EModel_type modelType);
  67. // utility function for mimes
  68. bool ExtractBiostrucAndBioseqs(ncbi::objects::CNcbi_mime_asn1& mime,
  69.     ncbi::CRef < ncbi::objects::CBiostruc >& biostruc, BioseqRefList *sequences);
  70. // Remove older entries until the cache is <= the given size (in MB).
  71. void TruncateCache(int maxSize);
  72. END_SCOPE(Cn3D)
  73. #endif // CN3D_CACHE__HPP
  74. /*
  75. * ---------------------------------------------------------------------------
  76. * $Log: cn3d_cache.hpp,v $
  77. * Revision 1000.1  2004/04/12 17:31:33  gouriano
  78. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.6
  79. *
  80. * Revision 1.6  2004/01/17 00:17:29  thiessen
  81. * add Biostruc and network structure load
  82. *
  83. * Revision 1.5  2003/04/02 17:49:18  thiessen
  84. * allow pdb id's in structure import dialog
  85. *
  86. * Revision 1.4  2003/02/03 19:20:02  thiessen
  87. * format changes: move CVS Log to bottom of file, remove std:: from .cpp files, and use new diagnostic macros
  88. *
  89. * Revision 1.3  2002/09/30 17:13:02  thiessen
  90. * change structure import to do sequences as well; change cache to hold mimes; change block aligner vocabulary; fix block aligner dialog bugs
  91. *
  92. * Revision 1.2  2002/02/27 16:29:41  thiessen
  93. * add model type flag to general mime type
  94. *
  95. * Revision 1.1  2001/10/30 02:54:12  thiessen
  96. * add Biostruc cache
  97. *
  98. */