seqref.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:10k
- /*
- * ===========================================================================
- * PRODUCTION $Log: seqref.hpp,v $
- * PRODUCTION Revision 1000.0 2004/04/12 17:37:57 gouriano
- * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
- * PRODUCTION
- * ===========================================================================
- */
- #ifndef SEQREF__HPP_INCLUDED
- #define SEQREF__HPP_INCLUDED
- /* */
- /* $Id: seqref.hpp,v 1000.0 2004/04/12 17:37:57 gouriano Exp $
- * ===========================================================================
- * PUBLIC DOMAIN NOTICE
- * National Center for Biotechnology Information
- *
- * This software/database is a "United States Government Work" under the
- * terms of the United States Copyright Act. It was written as part of
- * the author's official duties as a United States Government employee and
- * thus cannot be copyrighted. This software/database is freely available
- * to the public for use. The National Library of Medicine and the U.S.
- * Government have not placed any restriction on its use or reproduction.
- *
- * Although all reasonable efforts have been taken to ensure the accuracy
- * and reliability of the software and data, the NLM and the U.S.
- * Government do not and cannot warrant the performance or results that
- * may be obtained by using this software or data. The NLM and the U.S.
- * Government disclaim all warranties, express or implied, including
- * warranties of performance, merchantability or fitness for any particular
- * purpose.
- *
- * Please cite the author in any work or product based on this material.
- * ===========================================================================
- *
- * Author: Eugene Vasilchenko
- *
- * File Description: Base data reader interface
- *
- */
- #include <corelib/ncbiobj.hpp>
- #include <utility>
- #include <string>
- BEGIN_NCBI_SCOPE
- BEGIN_SCOPE(objects)
- class NCBI_XREADER_EXPORT CSeqref : public CObject
- {
- public:
- CSeqref(void);
- CSeqref(int gi, int sat, int satkey);
- virtual ~CSeqref(void);
-
- typedef TSeqPos TPos;
- typedef unsigned TConn;
- typedef pair<int, int> TKeyByTSE;
- const string print(void) const;
- const string printTSE(void) const;
- static const string printTSE(const TKeyByTSE& key);
- enum FFlags {
- fHasCore = 1 << 0,
- fHasDescr = 1 << 1,
- fHasSeqMap = 1 << 2,
- fHasSeqData = 1 << 3,
- fHasFeatures = 1 << 4,
- fHasExternal = 1 << 5,
- fHasAlign = 1 << 6,
- fHasGraph = 1 << 7,
- fHasAll = (1 << 16)-1,
- fHasAllLocal = fHasCore | fHasDescr | fHasSeqMap | fHasSeqData,
- fPossible = 1 << 16,
- fPrivate = 1 << 17
- };
- typedef int TFlags;
- int GetGi() const
- {
- return m_Gi;
- }
- int GetSat() const
- {
- return m_Sat;
- }
- int GetSatKey() const
- {
- return m_SatKey;
- }
- TKeyByTSE GetKeyByTSE(void) const
- {
- return TKeyByTSE(m_Sat, m_SatKey);
- }
- bool SameTSE(const CSeqref& seqRef) const
- {
- return m_Sat == seqRef.m_Sat && m_SatKey == seqRef.m_SatKey;
- }
- bool SameSeq(const CSeqref& seqRef) const
- {
- return m_Sat == seqRef.m_Sat && m_SatKey == seqRef.m_SatKey &&
- m_Gi == seqRef.m_Gi;
- }
- bool LessByTSE(const CSeqref& seqRef) const
- {
- return
- m_Sat < seqRef.m_Sat ||
- m_Sat == seqRef.m_Sat && m_SatKey < seqRef.m_SatKey;
- }
- bool LessBySeq(const CSeqref& seqRef) const
- {
- return
- m_Sat < seqRef.m_Sat ||
- m_Sat == seqRef.m_Sat &&
- (m_SatKey < seqRef.m_SatKey ||
- m_SatKey == seqRef.m_SatKey && m_Gi < seqRef.m_Gi);
- }
- TFlags GetFlags() const
- {
- return m_Flags;
- }
- void SetFlags(TFlags flags)
- {
- m_Flags = flags;
- }
- int GetVersion(void) const
- {
- return m_Version;
- }
- void SetVersion(int version)
- {
- m_Version = version;
- }
- protected:
- TFlags m_Flags;
- int m_Gi;
- int m_Sat;
- int m_SatKey;
- int m_Version;
- };
- END_SCOPE(objects)
- END_NCBI_SCOPE
- /*
- * $Log: seqref.hpp,v $
- * Revision 1000.0 2004/04/12 17:37:57 gouriano
- * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
- *
- * Revision 1.1 2004/01/13 16:55:53 vasilche
- * CReader, CSeqref and some more classes moved from xobjmgr to separate lib.
- * Headers moved from include/objmgr to include/objtools/data_loaders/genbank.
- *
- * Revision 1.35 2003/12/19 19:47:43 vasilche
- * Added support for TRACE data, Seq-id ::= general { db "ti", tag id NNN }.
- *
- * Revision 1.34 2003/12/02 16:17:42 kuznets
- * Added plugin manager support for CReader interface and implementaions
- * (id1 reader, pubseq reader)
- *
- * Revision 1.33 2003/11/26 17:55:53 vasilche
- * Implemented ID2 split in ID1 cache.
- * Fixed loading of splitted annotations.
- *
- * Revision 1.32 2003/10/27 18:50:48 vasilche
- * Detect 'private' blobs in ID1 reader.
- * Avoid reconnecting after ID1 server replied with error packet.
- *
- * Revision 1.31 2003/10/27 15:05:41 vasilche
- * Added correct recovery of cached ID1 loader if gi->sat/satkey cache is invalid.
- * Added recognition of ID1 error codes: private, etc.
- * Some formatting of old code.
- *
- * Revision 1.30 2003/10/08 14:16:12 vasilche
- * Added version of blobs loaded from ID1.
- *
- * Revision 1.29 2003/10/07 13:43:22 vasilche
- * Added proper handling of named Seq-annots.
- * Added feature search from named Seq-annots.
- * Added configurable adaptive annotation search (default: gene, cds, mrna).
- * Fixed selection of blobs for loading from GenBank.
- * Added debug checks to CSeq_id_Mapper for easier finding lost CSeq_id_Handles.
- * Fixed leaked split chunks annotation stubs.
- * Moved some classes definitions in separate *.cpp files.
- *
- * Revision 1.28 2003/09/30 16:21:59 vasilche
- * Updated internal object manager classes to be able to load ID2 data.
- * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
- * Scope caches results of requests for data to data loaders.
- * Optimized CSeq_id_Handle for gis.
- * Optimized bioseq lookup in scope.
- * Reduced object allocations in annotation iterators.
- * CScope is allowed to be destroyed before other objects using this scope are
- * deleted (feature iterators, bioseq handles etc).
- * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
- * Added 'adaptive' option to objmgr_demo application.
- *
- * Revision 1.27 2003/08/27 14:24:43 vasilche
- * Simplified CCmpTSE class.
- *
- * Revision 1.26 2003/08/14 21:34:42 kans
- * fixed inconsistent line endings that stopped Mac compilation
- *
- * Revision 1.25 2003/08/14 20:05:18 vasilche
- * Simple SNP features are stored as table internally.
- * They are recreated when needed using CFeat_CI.
- *
- * Revision 1.24 2003/07/24 19:28:08 vasilche
- * Implemented SNP split for ID1 loader.
- *
- * Revision 1.23 2003/07/17 20:07:55 vasilche
- * Reduced memory usage by feature indexes.
- * SNP data is loaded separately through PUBSEQ_OS.
- * String compression for SNP data.
- *
- * Revision 1.22 2003/04/24 16:12:37 vasilche
- * Object manager internal structures are splitted more straightforward.
- * Removed excessive header dependencies.
- *
- * Revision 1.21 2003/04/15 15:30:14 vasilche
- * Added include <memory> when needed.
- * Removed buggy buffer in printing methods.
- * Removed unnecessary include of stream_util.hpp.
- *
- * Revision 1.20 2003/04/15 14:24:07 vasilche
- * Changed CReader interface to not to use fake streams.
- *
- * Revision 1.19 2003/03/26 16:11:06 vasilche
- * Removed redundant const modifier from integral return types.
- *
- * Revision 1.18 2003/02/25 22:03:31 vasilche
- * Fixed identation.
- *
- * Revision 1.17 2002/12/26 20:51:35 dicuccio
- * Added Win32 export specifier
- *
- * Revision 1.16 2002/07/08 20:50:56 grichenk
- * Moved log to the end of file
- * Replaced static mutex (in CScope, CDataSource) with the mutex
- * pool. Redesigned CDataSource data locking.
- *
- * Revision 1.15 2002/05/06 20:37:08 ucko
- * Drop redundant CIStream:: which generated warnings under some compilers.
- *
- * Revision 1.14 2002/05/03 21:28:01 ucko
- * Introduce T(Signed)SeqPos.
- *
- * Revision 1.13 2002/04/08 18:37:56 ucko
- * Use IOS_BASE instead of ios_base for compatibility with old compilers.
- *
- * Revision 1.12 2002/03/27 20:22:32 butanaev
- * Added connection pool.
- *
- * Revision 1.11 2002/03/26 20:23:21 coremake
- * fake change
- *
- * Revision 1.10 2002/03/26 20:19:23 coremake
- * fake change
- *
- * Revision 1.9 2002/03/26 20:07:05 coremake
- * fake change
- *
- * Revision 1.8 2002/03/26 19:43:01 butanaev
- * Fixed compilation for g++.
- *
- * Revision 1.7 2002/03/26 18:48:30 butanaev
- * Fixed bug not deleting streambuf.
- *
- * Revision 1.6 2002/03/26 17:16:59 kimelman
- * reader stream fixes
- *
- * Revision 1.5 2002/03/22 18:49:23 kimelman
- * stream fix: WS skipping in binary stream
- *
- * Revision 1.4 2002/03/21 19:14:52 kimelman
- * GB related bugfixes
- *
- * Revision 1.3 2002/03/21 01:34:50 kimelman
- * gbloader related bugfixes
- *
- * Revision 1.2 2002/03/20 04:50:35 kimelman
- * GB loader added
- *
- * Revision 1.1 2002/01/11 19:04:03 gouriano
- * restructured objmgr
- *
- * Revision 1.5 2001/12/13 00:20:55 kimelman
- * bugfixes:
- *
- * Revision 1.4 2001/12/12 21:42:27 kimelman
- * a) int -> unsigned long
- * b) bool Compare -> int Compare
- *
- * Revision 1.3 2001/12/10 20:07:24 butanaev
- * Code cleanup.
- *
- * Revision 1.2 2001/12/07 21:25:19 butanaev
- * Interface development, code beautyfication.
- *
- * Revision 1.1 2001/12/07 16:11:44 butanaev
- * Switching to new reader interfaces.
- *
- * Revision 1.2 2001/12/06 18:06:22 butanaev
- * Ported to linux.
- *
- * Revision 1.1 2001/12/06 14:35:23 butanaev
- * New streamable interfaces designed, ID1 reimplemented.
- *
- */
- #endif//SEQREF__HPP_INCLUDED