seqmatch_info.hpp

ncbi源码

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

#ifndef OBJECTS_OBJMGR___SEQMATCH_INFO__HPP
#define OBJECTS_OBJMGR___SEQMATCH_INFO__HPP

/*  $Id: seqmatch_info.hpp,v 1000.0 2003/10/29 20:24:04 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:
*   CSeqMatch_Info -- used internally by CScope and CDataSource
*
*/


#include <corelib/ncbiobj.hpp>
#include <objmgr/seq_id_handle.hpp>
#include <objmgr/impl/tse_info.hpp>

BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)


class CDataSource;


////////////////////////////////////////////////////////////////////
//
//  CSeqMatch_Info::
//
//    Information about a sequence, matching to a seq-id
//


class NCBI_XOBJMGR_EXPORT CSeqMatch_Info
{
public:
    CSeqMatch_Info(void);
    CSeqMatch_Info(const CSeq_id_Handle& h, const CTSE_Info& tse);
    
    // Return true if "info" is better than "this"
    bool operator< (const CSeqMatch_Info& info) const;
    operator bool (void);
    bool operator! (void);

    CDataSource& GetDataSource(void) const;

    const CTSE_Info& GetTSE_Info(void) const;

    const CSeq_id_Handle& GetIdHandle(void) const;

    CConstRef<CBioseq_Info> GetBioseq_Info(void) const;

private:
    CSeq_id_Handle    m_Handle;     // best id handle, matching the request
    CConstRef<CTSE_Info>   m_TSE;   // TSE, containing the best match
};


inline
const CTSE_Info& CSeqMatch_Info::GetTSE_Info(void) const
{
    return *m_TSE;
}


inline
const CSeq_id_Handle& CSeqMatch_Info::GetIdHandle(void) const
{
    return m_Handle;
}


inline
CSeqMatch_Info::operator bool (void)
{
    return bool(m_Handle);
}


inline
bool CSeqMatch_Info::operator! (void)
{
    return !m_Handle;
}


END_SCOPE(objects)
END_NCBI_SCOPE

/*
* ---------------------------------------------------------------------------
* $Log: seqmatch_info.hpp,v $
* Revision 1000.0  2003/10/29 20:24:04  gouriano
* PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.14
*
* Revision 1.14  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.13  2003/05/20 15:44:37  vasilche
* Fixed interaction of CDataSource and CDataLoader in multithreaded app.
* Fixed some warnings on WorkShop.
* Added workaround for memory leak on WorkShop.
*
* Revision 1.12  2003/04/24 16:12:37  vasilche
* Object manager internal structures are splitted more straightforward.
* Removed excessive header dependencies.
*
* Revision 1.11  2003/03/21 19:22:48  grichenk
* Redesigned TSE locking, replaced CTSE_Lock with CRef<CTSE_Info>.
*
* Revision 1.10  2003/03/12 20:09:30  grichenk
* Redistributed members between CBioseq_Handle, CBioseq_Info and CTSE_Info
*
* Revision 1.9  2003/02/24 18:57:21  vasilche
* Make feature gathering in one linear pass using CSeqMap iterator.
* Do not use feture index by sub locations.
* Sort features at the end of gathering in one vector.
* Extracted some internal structures and classes in separate header.
* Delay creation of mapped features.
*
* Revision 1.8  2003/02/05 17:58:17  dicuccio
* Moved formerly private headers into include/objects/objmgr/impl
*
* Revision 1.7  2002/12/26 20:41:22  dicuccio
* Added Win32 export specifier.  Converted predeclaration (CTSE_Info) into
* #include for tse_info.hpp.
*
* Revision 1.6  2002/12/26 16:39:22  vasilche
* Object manager class CSeqMap rewritten.
*
* Revision 1.5  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.4  2002/06/04 17:18:32  kimelman
* memory cleanup :  new/delete/Cref rearrangements
*
* Revision 1.3  2002/05/06 03:30:36  vakatov
* OM/OM1 renaming
*
* Revision 1.2  2002/02/25 21:05:27  grichenk
* Removed seq-data references caching. Increased MT-safety. Fixed typos.
*
* Revision 1.1  2002/02/21 19:21:02  grichenk
* Initial revision
*
*
* ===========================================================================
*/

#endif  /* OBJECTS_OBJMGR___SEQMATCH_INFO__HPP */