生物技术

开发平台：
C/C++

bioseq_handle.hpp：源码内容
							/*
 * ===========================================================================
 * PRODUCTION $Log: bioseq_handle.hpp,v $
 * PRODUCTION Revision 1000.4  2004/06/01 19:21:17  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.56
 * PRODUCTION
 * ===========================================================================
 */
#ifndef BIOSEQ_HANDLE__HPP
#define BIOSEQ_HANDLE__HPP
/*  $Id: bioseq_handle.hpp,v 1000.4 2004/06/01 19:21:17 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: Aleksey Grichenko, Michael Kimelman, Eugene Vasilchenko
*
* File Description:
*
*/
#include <corelib/ncbistd.hpp>
#include <objects/seqloc/Na_strand.hpp>
#include <objects/seqset/Bioseq_set.hpp> // for EClass
#include <objects/seq/Seq_inst.hpp> // for EMol
#include <objmgr/seq_id_handle.hpp>
#include <objmgr/impl/heap_scope.hpp>
BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)
class CDataSource;
class CSeqMap;
class CSeqVector;
class CScope;
class CSeq_id;
class CSeq_loc;
class CBioseq_Info;
class CTSE_Info;
class CSeq_entry;
class CSeq_annot;
class CSeqMatch_Info;
class CSynonymsSet;
class CBioseq_ScopeInfo;
class CSeq_id_ScopeInfo;
class CBioseq_Handle;
class CSeq_annot_Handle;
class CSeq_entry_Handle;
class CBioseq_EditHandle;
class CBioseq_set_EditHandle;
class CSeq_annot_EditHandle;
class CSeq_entry_EditHandle;
// Bioseq handle -- must be a copy-safe const type.
class NCBI_XOBJMGR_EXPORT CBioseq_Handle
{
public:
    // Default constructor
    CBioseq_Handle(void);
    // Get scope this handle belongs to
    CScope& GetScope(void) const;
    // Get id used to obtain this bioseq handle
    CConstRef<CSeq_id> GetSeqId(void) const;
    const CSeq_id_Handle& GetSeq_id_Handle(void) const;
    // Check if this id can be used to obtain this bioseq handle
    bool IsSynonym(const CSeq_id& id) const;
    CConstRef<CSynonymsSet> GetSynonyms(void) const;
    // Get parent Seq-entry handle
    CSeq_entry_Handle GetParentEntry(void) const;
    CSeq_entry_Handle GetSeq_entry_Handle(void) const;
    // Get top level Seq-entry handle
    CSeq_entry_Handle GetTopLevelEntry(void) const;
    // Get 'edit' version of handle
    CBioseq_EditHandle GetEditHandle(void) const;
    // Bioseq core -- using partially populated CBioseq
    typedef CConstRef<CBioseq> TBioseqCore;
    // Get bioseq core structure
    TBioseqCore GetBioseqCore(void) const;
    // Get the complete bioseq
    CConstRef<CBioseq> GetCompleteBioseq(void) const;
    // Deprecated interface.
    const CBioseq& GetBioseq(void) const;
    const CSeq_entry& GetTopLevelSeqEntry(void) const;
    //////////////////////////////////////////////////////////////////
    // Bioseq members
    // id
    typedef vector<CSeq_id_Handle> TId;
    bool IsSetId(void) const;
    bool CanGetId(void) const;
    const TId& GetId(void) const;
    // descr
    typedef CSeq_descr TDescr;
    bool IsSetDescr(void) const;
    bool CanGetDescr(void) const;
    const TDescr& GetDescr(void) const;
    // inst
    typedef CSeq_inst TInst;
    bool IsSetInst(void) const;
    bool CanGetInst(void) const;
    const TInst& GetInst(void) const;
    // inst.repr
    typedef TInst::TRepr TInst_Repr;
    bool IsSetInst_Repr(void) const;
    bool CanGetInst_Repr(void) const;
    TInst_Repr GetInst_Repr(void) const;
    // inst.mol
    typedef TInst::TMol TInst_Mol;
    bool IsSetInst_Mol(void) const;
    bool CanGetInst_Mol(void) const;
    TInst_Mol GetInst_Mol(void) const;
    // inst.length
    typedef TInst::TLength TInst_Length;
    bool IsSetInst_Length(void) const;
    bool CanGetInst_Length(void) const;
    TInst_Length GetInst_Length(void) const;
    TSeqPos GetBioseqLength(void) const; // try to calculate it if not set
    // inst.fuzz
    typedef TInst::TFuzz TInst_Fuzz;
    bool IsSetInst_Fuzz(void) const;
    bool CanGetInst_Fuzz(void) const;
    const TInst_Fuzz& GetInst_Fuzz(void) const;
    // inst.topology
    typedef TInst::TTopology TInst_Topology;
    bool IsSetInst_Topology(void) const;
    bool CanGetInst_Topology(void) const;
    TInst_Topology GetInst_Topology(void) const;
    // inst.strand
    typedef TInst::TStrand TInst_Strand;
    bool IsSetInst_Strand(void) const;
    bool CanGetInst_Strand(void) const;
    TInst_Strand GetInst_Strand(void) const;
    // inst.seq-data
    typedef TInst::TSeq_data TInst_Seq_data;
    bool IsSetInst_Seq_data(void) const;
    bool CanGetInst_Seq_data(void) const;
    const TInst_Seq_data& GetInst_Seq_data(void) const;
    // inst.ext
    typedef TInst::TExt TInst_Ext;
    bool IsSetInst_Ext(void) const;
    bool CanGetInst_Ext(void) const;
    const TInst_Ext& GetInst_Ext(void) const;
    // inst.hist
    typedef TInst::THist TInst_Hist;
    bool IsSetInst_Hist(void) const;
    bool CanGetInst_Hist(void) const;
    const TInst_Hist& GetInst_Hist(void) const;
    // annot
    bool HasAnnots(void) const;
    //////////////////////////////////////////////////////////////////
    // Old interface:
    // Go up to a certain complexity level (or the nearest level of the same
    // priority if the required class is not found):
    // level   class
    // 0       not-set (0) ,
    // 3       nuc-prot (1) ,       -- nuc acid and coded proteins
    // 2       segset (2) ,         -- segmented sequence + parts
    // 2       conset (3) ,         -- constructed sequence + parts
    // 1       parts (4) ,          -- parts for 2 or 3
    // 1       gibb (5) ,           -- geninfo backbone
    // 1       gi (6) ,             -- geninfo
    // 5       genbank (7) ,        -- converted genbank
    // 3       pir (8) ,            -- converted pir
    // 4       pub-set (9) ,        -- all the seqs from a single publication
    // 4       equiv (10) ,         -- a set of equivalent maps or seqs
    // 3       swissprot (11) ,     -- converted SWISSPROT
    // 3       pdb-entry (12) ,     -- a complete PDB entry
    // 4       mut-set (13) ,       -- set of mutations
    // 4       pop-set (14) ,       -- population study
    // 4       phy-set (15) ,       -- phylogenetic study
    // 4       eco-set (16) ,       -- ecological sample study
    // 4       gen-prod-set (17) ,  -- genomic products, chrom+mRNa+protein
    // 4       wgs-set (18) ,       -- whole genome shotgun project
    // 0       other (255)
    CSeq_entry_Handle GetComplexityLevel(CBioseq_set::EClass cls) const;
    // Return level with exact complexity, or empty handle if not found.
    CSeq_entry_Handle GetExactComplexityLevel(CBioseq_set::EClass cls) const;
    // Get some values from core:
    CSeq_inst::TMol GetBioseqMolType(void) const;
    // Get sequence map.
    const CSeqMap& GetSeqMap(void) const;
    // CSeqVector constructor flags
    enum EVectorCoding {
        eCoding_NotSet, // Use original coding - DANGEROUS! - may change
        eCoding_Ncbi,   // Set coding to binary coding (Ncbi4na or Ncbistdaa)
        eCoding_Iupac   // Set coding to printable coding (Iupacna or Iupacaa)
    };
    enum EVectorStrand {
        eStrand_Plus,   // Plus strand
        eStrand_Minus   // Minus strand
    };
    // Get sequence: Iupacna or Iupacaa if use_iupac_coding is true
    CSeqVector GetSeqVector(EVectorCoding coding,
                            ENa_strand strand = eNa_strand_plus) const;
    CSeqVector GetSeqVector(ENa_strand strand = eNa_strand_plus) const;
    CSeqVector GetSeqVector(EVectorCoding coding, EVectorStrand strand) const;
    CSeqVector GetSeqVector(EVectorStrand strand) const;
    // Sequence filtering: get a seq-vector for a part of the sequence.
    // The part shown depends oon the mode selected. If the location
    // contains references to other sequences they are ignored (unlike
    // CBioseq constructor, which constructs a bioseq using all references
    // from a location). Strand information from "location" is ingored
    // when creating merged or excluded views. If "minus_strand" is true,
    // the result is reverse-complement.
    enum ESequenceViewMode {
        eViewConstructed,    // Do not merge or reorder intervals
        eViewMerged,         // Merge overlapping intervals, sort by location
        eViewExcluded        // Show intervals not included in the seq-loc
    };
    CSeqVector GetSequenceView(const CSeq_loc& location,
                               ESequenceViewMode mode,
                               EVectorCoding coding = eCoding_Ncbi,
                               ENa_strand strand = eNa_strand_plus) const;
    CConstRef<CSeqMap> GetSeqMapByLocation(const CSeq_loc& location,
                                           ESequenceViewMode mode) const;
    CRef<CSeq_loc> MapLocation(const CSeq_loc& loc) const;
    // Utility methods/operators
    // Comparison
    bool operator== (const CBioseq_Handle& h) const;
    bool operator!= (const CBioseq_Handle& h) const;
    bool operator<  (const CBioseq_Handle& h) const;
    // Check
    operator bool(void)  const;
    bool operator!(void) const;
    // these methods are for cross scope move only.
    CBioseq_EditHandle CopyTo(const CSeq_entry_EditHandle& entry,
                              int index = -1) const;
    CBioseq_EditHandle CopyTo(const CBioseq_set_EditHandle& seqset,
                              int index = -1) const;
    CBioseq_EditHandle CopyToSeq(const CSeq_entry_EditHandle& entry) const;
protected:
    friend class CScope_Impl;
    friend class CSynonymsSet;
    CBioseq_Handle(const CSeq_id_Handle& id, CBioseq_ScopeInfo* bioseq_info);
    const CBioseq_ScopeInfo& x_GetScopeInfo(void) const;
    CHeapScope          m_Scope;
    CSeq_id_Handle      m_Seq_id;
    CConstRef<CObject>  m_Bioseq_Info;
public: // non-public section
    const CBioseq_Info& x_GetInfo(void) const;
};
class NCBI_XOBJMGR_EXPORT CBioseq_EditHandle : public CBioseq_Handle
{
public:
    CBioseq_EditHandle(void);
    
    CSeq_entry_EditHandle GetParentEntry(void) const;
    // Modification functions
    //////////////////////////////////////////////////////////////////
    // Bioseq members
    // id
    void ResetId(void) const;
    bool AddId(const CSeq_id_Handle& id) const;
    bool RemoveId(const CSeq_id_Handle& id) const;
    // descr
    void SetDescr(TDescr& v) const;
    // inst
    void SetInst(TInst& v) const;
    // inst.repr
    void SetInst_Repr(TInst_Repr v) const;
    // inst.mol
    void SetInst_Mol(TInst_Mol v) const;
    // inst.length
    void SetInst_Length(TInst_Length v) const;
    // inst.fuzz
    void SetInst_Fuzz(TInst_Fuzz& v) const;
    // inst.topology
    void SetInst_Topology(TInst_Topology v) const;
    // inst.strand
    void SetInst_Strand(TInst_Strand v) const;
    // inst.seq-data
    void SetInst_Seq_data(TInst_Seq_data& v) const;
    // inst.ext
    void SetInst_Ext(TInst_Ext& v) const;
    // inst.hist
    void SetInst_Hist(TInst_Hist& v) const;
    // annot
    //////////////////////////////////////////////////////////////////
    // Add/remove/replace annotations:
    CSeq_annot_EditHandle AttachAnnot(const CSeq_annot& annot) const;
    CSeq_annot_EditHandle CopyAnnot(const CSeq_annot_Handle& annot) const;
    CSeq_annot_EditHandle TakeAnnot(const CSeq_annot_EditHandle& annot) const;
    // Tree modification, target handle must be in the same TSE
    // entry.Which() must be e_not_set or e_Set.
    CBioseq_EditHandle MoveTo(const CSeq_entry_EditHandle& entry,
                              int index = -1) const;
    CBioseq_EditHandle MoveTo(const CBioseq_set_EditHandle& seqset,
                              int index = -1) const;
    CBioseq_EditHandle MoveToSeq(const CSeq_entry_EditHandle& entry) const;
    void Remove(void) const;
protected:
    friend class CScope_Impl;
    CBioseq_EditHandle(const CBioseq_Handle& h);
public: // non-public section
    CBioseq_Info& x_GetInfo(void) const;
};
/////////////////////////////////////////////////////////////////////////////
// CBioseq_Handle inline methods
/////////////////////////////////////////////////////////////////////////////
inline
CBioseq_Handle::CBioseq_Handle(void)
{
}
inline
const CSeq_id_Handle& CBioseq_Handle::GetSeq_id_Handle(void) const
{
    return m_Seq_id;
}
inline
CBioseq_Handle::operator bool(void)  const
{
    return m_Bioseq_Info;
}
inline
bool CBioseq_Handle::operator!(void) const
{
    return !m_Bioseq_Info;
}
inline
const CBioseq_ScopeInfo& CBioseq_Handle::x_GetScopeInfo(void) const
{
    return reinterpret_cast<const CBioseq_ScopeInfo&>(*m_Bioseq_Info);
}
inline
CBioseq_Info& CBioseq_EditHandle::x_GetInfo(void) const
{
    return const_cast<CBioseq_Info&>(CBioseq_Handle::x_GetInfo());
}
inline
CScope& CBioseq_Handle::GetScope(void) const 
{
    return m_Scope;
}
inline
bool CBioseq_Handle::operator!= (const CBioseq_Handle& h) const
{
    return !(*this == h);
}
END_SCOPE(objects)
END_NCBI_SCOPE
/*
* ---------------------------------------------------------------------------
* $Log: bioseq_handle.hpp,v $
* Revision 1000.4  2004/06/01 19:21:17  gouriano
* PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.56
*
* Revision 1.56  2004/05/06 17:32:37  grichenk
* Added CanGetXXXX() methods
*
* Revision 1.55  2004/03/31 19:23:13  vasilche
* Fixed scope in CBioseq_Handle::GetEditHandle().
*
* Revision 1.54  2004/03/31 17:08:06  vasilche
* Implemented ConvertSeqToSet and ConvertSetToSeq.
*
* Revision 1.53  2004/03/29 20:13:05  vasilche
* Implemented whole set of methods to modify Seq-entry object tree.
* Added CBioseq_Handle::GetExactComplexityLevel().
*
* Revision 1.52  2004/03/25 19:27:43  vasilche
* Implemented MoveTo and CopyTo methods of handles.
*
* Revision 1.51  2004/03/24 18:30:28  vasilche
* Fixed edit API.
* Every *_Info object has its own shallow copy of original object.
*
* Revision 1.50  2004/03/16 21:01:32  vasilche
* Added methods to move Bioseq withing Seq-entry
*
* Revision 1.49  2004/03/16 15:47:26  vasilche
* Added CBioseq_set_Handle and set of EditHandles
*
* Revision 1.48  2004/02/06 16:07:26  grichenk
* Added CBioseq_Handle::GetSeq_entry_Handle()
* Fixed MapLocation()
*
* Revision 1.47  2003/11/28 15:13:24  grichenk
* Added CSeq_entry_Handle
*
* Revision 1.46  2003/11/17 16:03:12  grichenk
* Throw exception in CBioseq_Handle if the parent scope has been reset
*
* Revision 1.45  2003/11/10 18:12:43  grichenk
* Added MapLocation()
*
* Revision 1.44  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.43  2003/09/05 17:29:39  grichenk
* Structurized Object Manager exceptions
*
* Revision 1.42  2003/08/27 14:28:50  vasilche
* Reduce amount of object allocations in feature iteration.
*
* Revision 1.41  2003/07/15 16:14:06  grichenk
* CBioseqHandle::IsSynonym() made public
*
* Revision 1.40  2003/06/19 18:23:44  vasilche
* Added several CXxx_ScopeInfo classes for CScope related information.
* CBioseq_Handle now uses reference to CBioseq_ScopeInfo.
* Some fine tuning of locking in CScope.
*
* Revision 1.38  2003/05/20 15:44:36  vasilche
* Fixed interaction of CDataSource and CDataLoader in multithreaded app.
* Fixed some warnings on WorkShop.
* Added workaround for memory leak on WorkShop.
*
* Revision 1.37  2003/04/24 16:12:37  vasilche
* Object manager internal structures are splitted more straightforward.
* Removed excessive header dependencies.
*
* Revision 1.36  2003/03/27 19:39:34  grichenk
* +CBioseq_Handle::GetComplexityLevel()
*
* Revision 1.35  2003/03/21 19:22:48  grichenk
* Redesigned TSE locking, replaced CTSE_Lock with CRef<CTSE_Info>.
*
* Revision 1.34  2003/03/18 21:48:27  grichenk
* Removed obsolete class CAnnot_CI
*
* Revision 1.33  2003/03/18 14:46:35  grichenk
* Set limit object type to "none" if the object is null.
*
* Revision 1.32  2003/03/14 19:10:33  grichenk
* + SAnnotSelector::EIdResolving; fixed operator=() for several classes
*
* Revision 1.31  2003/03/12 20:09:30  grichenk
* Redistributed members between CBioseq_Handle, CBioseq_Info and CTSE_Info
*
* Revision 1.30  2003/02/27 14:35:32  vasilche
* Splitted PopulateTSESet() by logically independent parts.
*
* Revision 1.29  2003/01/23 19:33:57  vasilche
* Commented out obsolete methods.
* Use strand argument of CSeqVector instead of creation reversed seqmap.
* Fixed ordering operators of CBioseqHandle to be consistent.
*
* Revision 1.28  2003/01/22 20:11:53  vasilche
* Merged functionality of CSeqMapResolved_CI to CSeqMap_CI.
* CSeqMap_CI now supports resolution and iteration over sequence range.
* Added several caches to CScope.
* Optimized CSeqVector().
* Added serveral variants of CBioseqHandle::GetSeqVector().
* Tried to optimize annotations iterator (not much success).
* Rewritten CHandleRange and CHandleRangeMap classes to avoid sorting of list.
*
* Revision 1.27  2002/12/26 20:51:35  dicuccio
* Added Win32 export specifier
*
* Revision 1.26  2002/12/26 16:39:21  vasilche
* Object manager class CSeqMap rewritten.
*
* Revision 1.25  2002/11/08 22:15:50  grichenk
* Added methods for removing/replacing annotations
*
* Revision 1.24  2002/09/03 21:26:58  grichenk
* Replaced bool arguments in CSeqVector constructor and getters
* with enums.
*
* Revision 1.23  2002/08/23 16:49:06  grichenk
* Added warning about using CreateResolvedSeqMap()
*
* Revision 1.22  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.21  2002/06/12 14:39:00  grichenk
* Renamed enumerators
*
* Revision 1.20  2002/06/06 19:36:02  clausen
* Added GetTitle()
*
* Revision 1.19  2002/05/31 17:52:58  grichenk
* Optimized for better performance (CTSE_Info uses atomic counter,
* delayed annotations indexing, no location convertions in
* CAnnot_Types_CI if no references resolution is required etc.)
*
* Revision 1.18  2002/05/21 18:39:27  grichenk
* CBioseq_Handle::GetResolvedSeqMap() -> CreateResolvedSeqMap()
*
* Revision 1.17  2002/05/06 03:30:35  vakatov
* OM/OM1 renaming
*
* Revision 1.16  2002/05/03 18:35:36  grichenk
* throw -> THROW1_TRACE
*
* Revision 1.15  2002/04/23 19:01:06  grichenk
* Added optional flag to GetSeqVector() and GetSequenceView()
* for switching to IUPAC encoding.
*
* Revision 1.14  2002/04/22 20:06:58  grichenk
* +GetSequenceView(), +x_IsSynonym()
*
* Revision 1.13  2002/04/18 20:35:10  gouriano
* correction in comment
*
* Revision 1.12  2002/04/11 12:07:28  grichenk
* Redesigned CAnnotTypes_CI to resolve segmented sequences correctly.
*
* Revision 1.11  2002/03/19 19:17:33  gouriano
* added const qualifier to GetTitle and GetSeqVector
*
* Revision 1.10  2002/03/15 18:10:04  grichenk
* Removed CRef<CSeq_id> from CSeq_id_Handle, added
* key to seq-id map th CSeq_id_Mapper
*
* Revision 1.9  2002/03/04 15:08:43  grichenk
* Improved CTSE_Info locks
*
* Revision 1.8  2002/02/21 19:27:00  grichenk
* Rearranged includes. Added scope history. Added searching for the
* best seq-id match in data sources and scopes. Updated tests.
*
* Revision 1.7  2002/02/07 21:27:33  grichenk
* Redesigned CDataSource indexing: seq-id handle -> TSE -> seq/annot
*
* Revision 1.6  2002/02/01 21:49:10  gouriano
* minor changes to make it compilable and run on Solaris Workshop
*
* Revision 1.5  2002/01/29 17:05:53  grichenk
* GetHandle() -> GetKey()
*
* Revision 1.4  2002/01/28 19:45:33  gouriano
* changed the interface of BioseqHandle: two functions moved from Scope
*
* Revision 1.3  2002/01/23 21:59:29  grichenk
* Redesigned seq-id handles and mapper
*
* Revision 1.2  2002/01/16 16:26:36  gouriano
* restructured objmgr
*
* Revision 1.1  2002/01/11 19:04:00  gouriano
* restructured objmgr
*
*
* ===========================================================================
*/
#endif  // BIOSEQ_HANDLE__HPP

						