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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: seqdbcommon.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/15 15:04:51  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef CORELIB__SEQDB__SEQDBCOMMON_HPP
  10. #define CORELIB__SEQDB__SEQDBCOMMON_HPP
  11. /*  $Id: seqdbcommon.hpp,v 1000.0 2004/04/15 15:04:51 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. #include <ncbiconf.h>
  40. #include <corelib/ncbiobj.hpp>
  41. BEGIN_NCBI_SCOPE
  42. // Publically visible seqdb related definitions.
  43. class CSeqDBException : public CException {
  44. public:
  45.     enum EErrCode {
  46.         eArgErr,
  47.         eFileErr,
  48.         eMemErr
  49.     };
  50.     
  51.     virtual const char* GetErrCodeString(void) const {
  52.         switch ( GetErrCode() ) {
  53.         case eArgErr:         return "eArgErr";
  54.         case eFileErr:        return "eFileErr";
  55.         case eMemErr:         return "eMemErr";
  56.         default:              return CException::GetErrCodeString();
  57.         }
  58.     }
  59.     
  60.     NCBI_EXCEPTION_DEFAULT(CSeqDBException,CException);
  61. };
  62. // Protein / Nucleotide / Unknown are represented by 'p', 'n', and '-'.
  63. const char kSeqTypeProt = 'p';
  64. const char kSeqTypeNucl = 'n';
  65. const char kSeqTypeUnkn = '-';
  66. // Two output formats, used by CSeqDB::GetAmbigSeq(...)
  67. const Uint4 kSeqDBNuclNcbiNA8  = 0;
  68. const Uint4 kSeqDBNuclBlastNA8 = 1;
  69. // Flag specifying whether to use memory mapping.
  70. const bool kSeqDBMMap   = true;
  71. const bool kSeqDBNoMMap = false;
  72. // Certain methods have an "Alloc" version; if this is used, the
  73. // following can be used to indicate how to allocate returned data, so
  74. // that the user can use corresponding methods to delete the data.
  75. enum ESeqDBAllocType {
  76.     eMalloc = 1,
  77.     eNew
  78. };
  79. END_NCBI_SCOPE
  80. #endif // CORELIB__SEQDB__SEQDBCOMMON_HPP