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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: seqdbimpl.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/15 15:06:02  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.18
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_READERS_SEQDB__SEQDBIMPL_HPP
  10. #define OBJTOOLS_READERS_SEQDB__SEQDBIMPL_HPP
  11. /*  $Id: seqdbimpl.hpp,v 1000.0 2004/04/15 15:06:02 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Author:  Kevin Bealer
  37.  *
  38.  */
  39. /// CSeqDBImpl class
  40. /// 
  41. /// This is the main implementation layer of the CSeqDB class.  This
  42. /// is seperated from that class so that various implementation
  43. /// details of CSeqDB are kept from the public interface.
  44. #include "seqdbmempool.hpp"
  45. #include "seqdbvolset.hpp"
  46. #include "seqdbalias.hpp"
  47. #include "seqdboidlist.hpp"
  48. BEGIN_NCBI_SCOPE
  49. using namespace ncbi::objects;
  50. class CSeqDBImpl {
  51. public:
  52.     CSeqDBImpl(const string & db_name_list,
  53.                char           prot_nucl,
  54.                Uint4          oid_begin,
  55.                Uint4          oid_end,
  56.                bool           use_mmap);
  57.     
  58.     ~CSeqDBImpl(void);
  59.     
  60.     Uint4 GetSeqLength(Uint4 oid) const;
  61.     
  62.     Uint4 GetSeqLengthApprox(Uint4 oid) const;
  63.     
  64.     CRef<CBlast_def_line_set> GetHdr(Uint4 oid) const;
  65.     
  66.     char GetSeqType(void) const;
  67.     
  68.     CRef<CBioseq> GetBioseq(Uint4 oid,
  69.                             bool  use_objmgr,
  70.                             bool  insert_ctrlA) const;
  71.     
  72.     Uint4 GetSequence(Uint4 oid, const char ** buffer) const;
  73.     
  74.     Uint4 GetAmbigSeq(Uint4            oid,
  75.                       char         ** buffer,
  76.                       Uint4           nucl_code,
  77.                       ESeqDBAllocType strategy) const;
  78.     
  79.     void RetSequence(const char ** buffer) const;
  80.     
  81.     list< CRef<CSeq_id> > GetSeqIDs(Uint4 oid) const;
  82.     
  83.     string GetTitle(void) const;
  84.     
  85.     string GetDate(void) const;
  86.     
  87.     Uint4 GetNumSeqs(void) const;
  88.     
  89.     Uint8 GetTotalLength(void) const;
  90.     
  91.     Uint4 GetMaxLength(void) const;
  92.     
  93.     bool CheckOrFindOID(Uint4 & next_oid) const;
  94.     
  95.     const string & GetDBNameList(void) const;
  96.     
  97. private:
  98.     string x_FixString(const string &) const;
  99.     
  100.     string                m_DBNames;
  101.     mutable CSeqDBMemPool m_MemPool;
  102.     CSeqDBAliasFile       m_Aliases;
  103.     CSeqDBVolSet          m_VolSet;
  104.     CRef<CSeqDBOIDList>   m_OIDList;
  105.     Uint4                 m_RestrictBegin;
  106.     Uint4                 m_RestrictEnd;
  107. };
  108. END_NCBI_SCOPE
  109. #endif // OBJTOOLS_READERS_SEQDB__SEQDBIMPL_HPP