seq_map.hpp

来自「ncbi源码」· HPP 代码 · 共 214 行

/*
 * ===========================================================================
 * PRODUCTION $Log: seq_map.hpp,v $
 * PRODUCTION Revision 1000.0  2004/06/01 19:55:57  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_OBJUTILS___SEQ_MAP__HPP
#define GUI_OBJUTILS___SEQ_MAP__HPP

/*  $Id: seq_map.hpp,v 1000.0 2004/06/01 19:55: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.
 *
 * ===========================================================================
 *
 * Authors:  Vlad Lebedev
 *
 * File Description:
 *   CLayoutSeqMap -- utility class to layout sequence segments and 
 *                    hold CSeq_id_Handle objects
 */


#include <corelib/ncbiobj.hpp>
#include <gui/objutils/layout.hpp>

#include <objects/seqloc/Seq_interval.hpp>
#include <objmgr/seq_id_handle.hpp>

/** @addtogroup GUI_OBJUTILS
 *
 * @{
 */


BEGIN_NCBI_SCOPE


class NCBI_GUIOBJUTILS_EXPORT CLayoutSeqMap : public CLayoutObject
{
public:
    typedef vector< CRef<CLayoutSeqMap> > TSeqMapList;
    
    // ctors
    CLayoutSeqMap(objects::CSeq_id_Handle hndl,
            const TSeqRange& range, const TSeqRange& ref_range);

    // Access the data as a CObject
    const CObject* GetObject(TSeqPos pos) const;
    bool HasObject(const CObject* obj) const;

    // Access the remapped location
    const objects::CSeq_loc&  GetLocation(void) const;
    const objects::CSeq_loc&  GetRefLocation(void) const;
    const objects::CSeq_id&   GetSeqID(void) const;

    // retrieve the type of this object
    EType GetType() const;

    //
    // pure virtual requirements
    //    
    // Comparators
    bool LessByPos (const CLayoutObject& obj) const;
    bool LessBySize(const CLayoutObject& obj) const;


protected:
    // pointer to the actual seq data
    objects::CSeq_id_Handle     m_SeqHandle;
    CRef<objects::CSeq_loc> 	m_Location;
    CRef<objects::CSeq_loc> 	m_RefLocation;
};


inline
bool CLayoutSeqMap::LessByPos(const CLayoutObject& obj) const
{
    TSeqRange r0 = GetLocation().GetTotalRange();
    TSeqRange r1 = obj.GetLocation().GetTotalRange();
    return (r0.GetFrom() < r1.GetFrom());
}


inline
bool CLayoutSeqMap::LessBySize(const CLayoutObject& obj) const
{
    TSeqRange r0 = GetLocation().GetTotalRange();
    TSeqRange r1 = obj.GetLocation().GetTotalRange();
    return (r0.GetLength() < r1.GetLength());
}


inline
const CObject* CLayoutSeqMap::GetObject(TSeqPos pos) const
{
    TSeqRange r = GetLocation().GetTotalRange();
    if (pos >= r.GetFrom()  &&  pos <= r.GetTo()) {
        return m_SeqHandle.GetSeqId().GetPointer();
    }
    return NULL;
}


inline
bool CLayoutSeqMap::HasObject(const CObject* obj) const
{
    return m_SeqHandle.GetSeqId().GetPointer() == obj;
}


inline
const objects::CSeq_id& CLayoutSeqMap::GetSeqID(void) const
{
    return *m_SeqHandle.GetSeqId();
}


inline
const objects::CSeq_loc& CLayoutSeqMap::GetLocation(void) const
{
    return *m_Location;
}

inline
const objects::CSeq_loc& CLayoutSeqMap::GetRefLocation(void) const
{
    return *m_RefLocation;
}


inline
CLayoutSeqMap::EType CLayoutSeqMap::GetType() const
{
    return eSeqMap;
}




END_NCBI_SCOPE

/* @} */



/*
 * ===========================================================================
 * $Log: seq_map.hpp,v $
 * Revision 1000.0  2004/06/01 19:55:57  gouriano
 * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
 *
 * Revision 1.4  2004/05/14 14:24:47  dicuccio
 * Added new pure virtual requirement on CLayoutObject(): GetType(), returns enum
 * defined in CLayoutObject
 *
 * Revision 1.3  2004/05/03 13:34:54  dicuccio
 * FIxed include guards, doxygen groups
 *
 * Revision 1.2  2004/05/03 12:41:35  dicuccio
 * Fixed #includes and export specifiers
 *
 * Revision 1.1  2004/04/30 11:52:53  dicuccio
 * Split out from gui/utils
 *
 * Revision 1.7  2004/04/16 14:27:17  dicuccio
 * Added doxygen module tag
 *
 * Revision 1.6  2004/04/15 12:57:44  lebedev
 * Changed GetObject to return NULL or const pointer based on given position
 *
 * Revision 1.5  2004/04/01 20:10:30  rsmith
 * take out redundant & illegal class specifier
 *
 * Revision 1.4  2004/03/23 12:23:51  lebedev
 * Changed seq_map to hold CSeq_id_Handle
 *
 * Revision 1.3  2004/03/11 17:20:23  dicuccio
 * Use gui/gui instead of gui/types.  Use TSeqRange instead of TRange
 *
 * Revision 1.2  2003/11/04 13:09:54  lebedev
 * Reference location added
 *
 * Revision 1.1  2003/10/30 13:18:51  lebedev
 * Initial revision
 *
 * ===========================================================================
 */

 
#endif  // GUI_OBJUTILS___SEQ_MAP__HPP