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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: seqref.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/12 17:37:57  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef SEQREF__HPP_INCLUDED
  10. #define SEQREF__HPP_INCLUDED
  11. /* */
  12. /*  $Id: seqref.hpp,v 1000.0 2004/04/12 17:37:57 gouriano Exp $
  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. *  Author:  Eugene Vasilchenko
  36. *
  37. *  File Description: Base data reader interface
  38. *
  39. */
  40. #include <corelib/ncbiobj.hpp>
  41. #include <utility>
  42. #include <string>
  43. BEGIN_NCBI_SCOPE
  44. BEGIN_SCOPE(objects)
  45. class NCBI_XREADER_EXPORT CSeqref : public CObject
  46. {
  47. public:
  48.     CSeqref(void);
  49.     CSeqref(int gi, int sat, int satkey);
  50.     virtual ~CSeqref(void);
  51.     
  52.     typedef TSeqPos TPos;
  53.     typedef unsigned TConn;
  54.     typedef pair<int, int> TKeyByTSE;
  55.     const string print(void)    const;
  56.     const string printTSE(void) const;
  57.     static const string printTSE(const TKeyByTSE& key);
  58.     enum FFlags {
  59.         fHasCore     = 1 << 0,
  60.         fHasDescr    = 1 << 1,
  61.         fHasSeqMap   = 1 << 2,
  62.         fHasSeqData  = 1 << 3,
  63.         fHasFeatures = 1 << 4,
  64.         fHasExternal = 1 << 5,
  65.         fHasAlign    = 1 << 6,
  66.         fHasGraph    = 1 << 7,
  67.         fHasAll      = (1 << 16)-1,
  68.         fHasAllLocal = fHasCore | fHasDescr | fHasSeqMap | fHasSeqData,
  69.         fPossible    = 1 << 16,
  70.         fPrivate     = 1 << 17
  71.     };
  72.     typedef int TFlags;
  73.     int GetGi() const
  74.         {
  75.             return m_Gi;
  76.         }
  77.     int GetSat() const
  78.         {
  79.             return m_Sat;
  80.         }
  81.     int GetSatKey() const
  82.         {
  83.             return m_SatKey;
  84.         }
  85.     TKeyByTSE GetKeyByTSE(void) const
  86.         {
  87.             return TKeyByTSE(m_Sat, m_SatKey);
  88.         }
  89.     bool SameTSE(const CSeqref& seqRef) const
  90.         {
  91.             return m_Sat == seqRef.m_Sat && m_SatKey == seqRef.m_SatKey;
  92.         }
  93.     bool SameSeq(const CSeqref& seqRef) const
  94.         {
  95.             return m_Sat == seqRef.m_Sat && m_SatKey == seqRef.m_SatKey &&
  96.                 m_Gi == seqRef.m_Gi;
  97.         }
  98.     bool LessByTSE(const CSeqref& seqRef) const
  99.         {
  100.             return
  101.                 m_Sat < seqRef.m_Sat ||
  102.                 m_Sat == seqRef.m_Sat && m_SatKey < seqRef.m_SatKey;
  103.         }
  104.     bool LessBySeq(const CSeqref& seqRef) const
  105.         {
  106.             return
  107.                 m_Sat < seqRef.m_Sat ||
  108.                 m_Sat == seqRef.m_Sat &&
  109.                 (m_SatKey < seqRef.m_SatKey ||
  110.                  m_SatKey == seqRef.m_SatKey && m_Gi < seqRef.m_Gi);
  111.         }
  112.     TFlags  GetFlags() const
  113.         {
  114.             return m_Flags;
  115.         }
  116.     void SetFlags(TFlags flags)
  117.         {
  118.             m_Flags = flags;
  119.         }
  120.     int GetVersion(void) const
  121.         {
  122.             return m_Version;
  123.         }
  124.     void SetVersion(int version)
  125.         {
  126.             m_Version = version;
  127.         }
  128. protected:
  129.     TFlags  m_Flags;
  130.     int m_Gi;
  131.     int m_Sat;
  132.     int m_SatKey;
  133.     int m_Version;
  134. };
  135. END_SCOPE(objects)
  136. END_NCBI_SCOPE
  137. /*
  138. * $Log: seqref.hpp,v $
  139. * Revision 1000.0  2004/04/12 17:37:57  gouriano
  140. * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
  141. *
  142. * Revision 1.1  2004/01/13 16:55:53  vasilche
  143. * CReader, CSeqref and some more classes moved from xobjmgr to separate lib.
  144. * Headers moved from include/objmgr to include/objtools/data_loaders/genbank.
  145. *
  146. * Revision 1.35  2003/12/19 19:47:43  vasilche
  147. * Added support for TRACE data, Seq-id ::= general { db "ti", tag id NNN }.
  148. *
  149. * Revision 1.34  2003/12/02 16:17:42  kuznets
  150. * Added plugin manager support for CReader interface and implementaions
  151. * (id1 reader, pubseq reader)
  152. *
  153. * Revision 1.33  2003/11/26 17:55:53  vasilche
  154. * Implemented ID2 split in ID1 cache.
  155. * Fixed loading of splitted annotations.
  156. *
  157. * Revision 1.32  2003/10/27 18:50:48  vasilche
  158. * Detect 'private' blobs in ID1 reader.
  159. * Avoid reconnecting after ID1 server replied with error packet.
  160. *
  161. * Revision 1.31  2003/10/27 15:05:41  vasilche
  162. * Added correct recovery of cached ID1 loader if gi->sat/satkey cache is invalid.
  163. * Added recognition of ID1 error codes: private, etc.
  164. * Some formatting of old code.
  165. *
  166. * Revision 1.30  2003/10/08 14:16:12  vasilche
  167. * Added version of blobs loaded from ID1.
  168. *
  169. * Revision 1.29  2003/10/07 13:43:22  vasilche
  170. * Added proper handling of named Seq-annots.
  171. * Added feature search from named Seq-annots.
  172. * Added configurable adaptive annotation search (default: gene, cds, mrna).
  173. * Fixed selection of blobs for loading from GenBank.
  174. * Added debug checks to CSeq_id_Mapper for easier finding lost CSeq_id_Handles.
  175. * Fixed leaked split chunks annotation stubs.
  176. * Moved some classes definitions in separate *.cpp files.
  177. *
  178. * Revision 1.28  2003/09/30 16:21:59  vasilche
  179. * Updated internal object manager classes to be able to load ID2 data.
  180. * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
  181. * Scope caches results of requests for data to data loaders.
  182. * Optimized CSeq_id_Handle for gis.
  183. * Optimized bioseq lookup in scope.
  184. * Reduced object allocations in annotation iterators.
  185. * CScope is allowed to be destroyed before other objects using this scope are
  186. * deleted (feature iterators, bioseq handles etc).
  187. * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
  188. * Added 'adaptive' option to objmgr_demo application.
  189. *
  190. * Revision 1.27  2003/08/27 14:24:43  vasilche
  191. * Simplified CCmpTSE class.
  192. *
  193. * Revision 1.26  2003/08/14 21:34:42  kans
  194. * fixed inconsistent line endings that stopped Mac compilation
  195. *
  196. * Revision 1.25  2003/08/14 20:05:18  vasilche
  197. * Simple SNP features are stored as table internally.
  198. * They are recreated when needed using CFeat_CI.
  199. *
  200. * Revision 1.24  2003/07/24 19:28:08  vasilche
  201. * Implemented SNP split for ID1 loader.
  202. *
  203. * Revision 1.23  2003/07/17 20:07:55  vasilche
  204. * Reduced memory usage by feature indexes.
  205. * SNP data is loaded separately through PUBSEQ_OS.
  206. * String compression for SNP data.
  207. *
  208. * Revision 1.22  2003/04/24 16:12:37  vasilche
  209. * Object manager internal structures are splitted more straightforward.
  210. * Removed excessive header dependencies.
  211. *
  212. * Revision 1.21  2003/04/15 15:30:14  vasilche
  213. * Added include <memory> when needed.
  214. * Removed buggy buffer in printing methods.
  215. * Removed unnecessary include of stream_util.hpp.
  216. *
  217. * Revision 1.20  2003/04/15 14:24:07  vasilche
  218. * Changed CReader interface to not to use fake streams.
  219. *
  220. * Revision 1.19  2003/03/26 16:11:06  vasilche
  221. * Removed redundant const modifier from integral return types.
  222. *
  223. * Revision 1.18  2003/02/25 22:03:31  vasilche
  224. * Fixed identation.
  225. *
  226. * Revision 1.17  2002/12/26 20:51:35  dicuccio
  227. * Added Win32 export specifier
  228. *
  229. * Revision 1.16  2002/07/08 20:50:56  grichenk
  230. * Moved log to the end of file
  231. * Replaced static mutex (in CScope, CDataSource) with the mutex
  232. * pool. Redesigned CDataSource data locking.
  233. *
  234. * Revision 1.15  2002/05/06 20:37:08  ucko
  235. * Drop redundant CIStream:: which generated warnings under some compilers.
  236. *
  237. * Revision 1.14  2002/05/03 21:28:01  ucko
  238. * Introduce T(Signed)SeqPos.
  239. *
  240. * Revision 1.13  2002/04/08 18:37:56  ucko
  241. * Use IOS_BASE instead of ios_base for compatibility with old compilers.
  242. *
  243. * Revision 1.12  2002/03/27 20:22:32  butanaev
  244. * Added connection pool.
  245. *
  246. * Revision 1.11  2002/03/26 20:23:21  coremake
  247. * fake change
  248. *
  249. * Revision 1.10  2002/03/26 20:19:23  coremake
  250. * fake change
  251. *
  252. * Revision 1.9  2002/03/26 20:07:05  coremake
  253. * fake change
  254. *
  255. * Revision 1.8  2002/03/26 19:43:01  butanaev
  256. * Fixed compilation for g++.
  257. *
  258. * Revision 1.7  2002/03/26 18:48:30  butanaev
  259. * Fixed bug not deleting streambuf.
  260. *
  261. * Revision 1.6  2002/03/26 17:16:59  kimelman
  262. * reader stream fixes
  263. *
  264. * Revision 1.5  2002/03/22 18:49:23  kimelman
  265. * stream fix: WS skipping in binary stream
  266. *
  267. * Revision 1.4  2002/03/21 19:14:52  kimelman
  268. * GB related bugfixes
  269. *
  270. * Revision 1.3  2002/03/21 01:34:50  kimelman
  271. * gbloader related bugfixes
  272. *
  273. * Revision 1.2  2002/03/20 04:50:35  kimelman
  274. * GB loader added
  275. *
  276. * Revision 1.1  2002/01/11 19:04:03  gouriano
  277. * restructured objmgr
  278. *
  279. * Revision 1.5  2001/12/13 00:20:55  kimelman
  280. * bugfixes:
  281. *
  282. * Revision 1.4  2001/12/12 21:42:27  kimelman
  283. * a) int -> unsigned long
  284. * b) bool Compare -> int Compare
  285. *
  286. * Revision 1.3  2001/12/10 20:07:24  butanaev
  287. * Code cleanup.
  288. *
  289. * Revision 1.2  2001/12/07 21:25:19  butanaev
  290. * Interface development, code beautyfication.
  291. *
  292. * Revision 1.1  2001/12/07 16:11:44  butanaev
  293. * Switching to new reader interfaces.
  294. *
  295. * Revision 1.2  2001/12/06 18:06:22  butanaev
  296. * Ported to linux.
  297. *
  298. * Revision 1.1  2001/12/06 14:35:23  butanaev
  299. * New streamable interfaces designed, ID1 reimplemented.
  300. *
  301. */
  302. #endif//SEQREF__HPP_INCLUDED