tse_ci.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: tse_ci.hpp,v $
 * PRODUCTION Revision 1000.0  2003/10/29 20:24:10  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
 * PRODUCTION
 * ===========================================================================
 */

#ifndef TSE_CI__HPP
#define TSE_CI__HPP

/*  $Id: tse_ci.hpp,v 1000.0 2003/10/29 20:24:10 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
*
* File Description:
*   Iterates over TSEs from a given scope. To be used together with
*   CBioseq_CI and CFeat_CI to get all objects from a scope.
*
*/


#include <objmgr/scope.hpp>
#include <corelib/ncbistd.hpp>

BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)


class NCBI_XOBJMGR_EXPORT CTSE_CI
{
public:
    // 'ctors
    CTSE_CI(void);
    // Iterate over TSEs taken from the scope.
    CTSE_CI(CScope& scope);
    CTSE_CI(const CTSE_CI& tse_ci);
    ~CTSE_CI(void);

    CTSE_CI& operator= (const CTSE_CI& tse_ci);
    CTSE_CI& operator++ (void);
    operator bool (void) const;

    const CSeq_entry& operator* (void) const;
    const CSeq_entry* operator-> (void) const;

private:
    typedef set<TTSE_Lock>          TTSE_LockSet;
    typedef TTSE_LockSet::const_iterator TTSEIterator;

    CHeapScope    m_Scope;
    TTSE_LockSet  m_Entries;
    TTSEIterator  m_Current;
};


inline
CTSE_CI::CTSE_CI(void)
{
    m_Current = m_Entries.end();
}

inline
CTSE_CI::CTSE_CI(CScope& scope)
    : m_Scope(&scope)
{
    ITERATE (CScope::TRequestHistory, it, m_Scope->x_GetHistory()) {
        m_Entries.insert(*it);
    }
    m_Current = m_Entries.begin();
}

inline
CTSE_CI::CTSE_CI(const CTSE_CI& tse_ci)
{
    *this = tse_ci;
}

inline
CTSE_CI::~CTSE_CI(void)
{
}

inline
CTSE_CI& CTSE_CI::operator= (const CTSE_CI& tse_ci)
{
    if (this != &tse_ci) {
        m_Scope = tse_ci.m_Scope;
        ITERATE (TTSE_LockSet, it, tse_ci.m_Entries) {
            m_Entries.insert(*it);
        }
        if (tse_ci) {
            m_Current = m_Entries.find(*tse_ci.m_Current);
        }
        else {
            m_Current = m_Entries.end();
        }
    }
    return *this;
}

inline
CTSE_CI& CTSE_CI::operator++ (void)
{
    if ( m_Scope  &&  m_Current != m_Entries.end() ) {
        m_Current++;
    }
    return *this;
}

inline
CTSE_CI::operator bool (void) const
{
    return m_Scope  &&  m_Current != m_Entries.end();
}

inline
const CSeq_entry& CTSE_CI::operator* (void) const
{
    return m_Scope->x_GetTSEFromInfo(*m_Current);
}

inline
const CSeq_entry* CTSE_CI::operator-> (void) const
{
    return &m_Scope->x_GetTSEFromInfo(*m_Current);
}



END_SCOPE(objects)
END_NCBI_SCOPE

/*
* ---------------------------------------------------------------------------
* $Log: tse_ci.hpp,v $
* Revision 1000.0  2003/10/29 20:24:10  gouriano
* PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
*
* Revision 1.5  2003/10/08 17:55:53  vasilche
* Fixed null initialization of CHeapScope.
*
* Revision 1.4  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.3  2003/06/02 16:01:36  dicuccio
* Rearranged include/objects/ subtree.  This includes the following shifts:
*     - include/objects/alnmgr --> include/objtools/alnmgr
*     - include/objects/cddalignview --> include/objtools/cddalignview
*     - include/objects/flat --> include/objtools/flat
*     - include/objects/objmgr/ --> include/objmgr/
*     - include/objects/util/ --> include/objmgr/util/
*     - include/objects/validator --> include/objtools/validator
*
* Revision 1.2  2003/04/29 19:51:12  vasilche
* Fixed interaction of Data Loader garbage collector and TSE locking mechanism.
* Made some typedefs more consistent.
*
* Revision 1.1  2003/03/24 21:26:02  grichenk
* Initial revision
*
*
* ===========================================================================
*/

#endif  // TSE_CI__HPP