bins_track.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef GUI_PACKAGES_SNP_BINS_TRACK__BINS_TRACK__HPP
#define GUI_PACKAGES_SNP_BINS_TRACK__BINS_TRACK__HPP
 
/*  $Id: bins_track.hpp 36620 2016-10-14 20:34:56Z katargir $
 * ===========================================================================
 *
 *                            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:  Melvin Quintos
 *
 * File Description:
 *    This file contains class declarations for CBinsTrack and CBinsTrackFactory
 *
 */
 
#include <corelib/ncbiobj.hpp>
#include <gui/utils/extension.hpp>
#include <gui/widgets/seq_graphic/data_track.hpp>
#include <gui/widgets/seq_graphic/seqgraphic_job_result.hpp>
#include <gui/packages/pkg_snp/bins/bins_ds.hpp>
 
#include <objects/seqloc/Seq_interval.hpp>
#include <objmgr/annot_selector.hpp>
#include <objtools/snputil/snp_bins.hpp>
 
 
BEGIN_NCBI_SCOPE
 
///////////////////////////////////////////////////////////////////////////////
//   CBinsTrack
///////////////////////////////////////////////////////////////////////////////
class NCBI_GUIWIDGETS_SNP_EXPORT CBinsTrack :
    public CDataTrack
{
    friend class CBinsTrackFactory;
 
public:
    CBinsTrack(CBinsDS* ds, CRenderingContext* r_cntx);
    virtual ~CBinsTrack();
 
    /// @name CDataTrack reimplemented methods.
    /// @{
    virtual CRef<CSGGenBankDS>  GetDataSource();
    virtual CConstRef<CSGGenBankDS>  GetDataSource() const;
    /// @}
 
    virtual void GetHTMLActiveAreas(TAreaVector* p_areas) const;
    virtual CHTMLActiveArea* InitHTMLActiveArea(TAreaVector* p_areas) const;
 
    /// @name CLayoutTrack reimplemented methods.
    /// @{
    virtual const CTrackTypeInfo&  GetTypeInfo() const;
    virtual string GetFullTitle() const;
    /// @}
    void SetAnnot(const string& name);
 
    /// expose global configuration
    ///
    /// needed to get color scheme
    CConstRef<CSeqGraphicConfig> GetGlobalConfig() const { return x_GetGlobalConfig(); }
 
protected:
    virtual void x_LoadSettings(const string& preset_style,
                                const TKeyValuePairs& settings);
    virtual void x_OnIconClicked(TIconID id);
 
    /// @name CDataTrack pure virtual interfaces
    /// @{
    virtual void x_UpdateData();
    virtual void x_OnJobCompleted(CAppJobNotification& notify);
    /// @}
 
    void x_ProcessBinsJobResult(const SBinsJobResult& result);
 
private:
    /// @name prohibited copy constructor and assignment operator.
    /// @{
    CBinsTrack(const CBinsTrack&);
    CBinsTrack& operator=(const CBinsTrack&);
    /// @}
 
    bool x_IsOverviewMode() const;
 
private:
 
    objects::NSnpBins::TBinType      m_BinType;
 
    enum ELayout {
        eLayout_Adaptive = 260,  ///< All SNPs drawn in one line
        eLayout_Density,         ///< Always show density
        eLayout_Features,        ///< Show features whenever possible
        eLayout_Labels           ///< Show labels and cascade features (CLayeredLayoutPolicy)
    };
 
    int                     m_eLayout;
    
    CRef<CBinsDS>           m_DS;
    objects::SAnnotSelector m_FeatSel;
    
    SIconInfo               m_IconLayout;
    CRef<SBinsJobResult>    m_JobResult;
    string                  m_AnnotName;
    string                  m_PreferredTitle;
 
    static CTrackTypeInfo   m_TypeInfo;
 
 
};
 
///////////////////////////////////////////////////////////////////////////////
//   CBinsTrackFactory
///////////////////////////////////////////////////////////////////////////////
class NCBI_GUIWIDGETS_SNP_EXPORT CBinsTrackFactory :
    public CObject,
    public ILayoutTrackFactory,
    public ITrackConfigurable,
    public IExtension
{
public:
    CBinsTrackFactory(){}
 
    static const CTrackTypeInfo& GetTypeInfo()
        { return CBinsTrack::m_TypeInfo; }
 
    /// @name ILayoutTrackFactory interface implementation
    /// @{
    virtual TTrackMap CreateTracks(
        SConstScopedObject& object,
        ISGDataSourceContext* ds_context,
        CRenderingContext* r_cntx,
        const SExtraParams& params = SExtraParams(),
        const TAnnotMetaDataList& src_annots = TAnnotMetaDataList()) const;
 
    virtual void GetMatchedAnnots(
        const TAnnotMetaDataList& src_annots,
        const ILayoutTrackFactory::SExtraParams& params,
        TAnnotNameTitleMap& out_annots) const;
 
    virtual bool UnderstandLevel() const
    { return true; }
 
    virtual bool NeedBackgroundInit() const
    { return true; }
 
    virtual const CTrackTypeInfo&  GetThisTypeInfo() const
        { return GetTypeInfo(); }
    /// @}
 
    /// @name ITrackConfigurable reimplemented methods.
    /// @{
    CRef<objects::CTrackConfigSet>
    GetSettings(const string& profile,
                const TKeyValuePairs& settings,
                const CTempTrackProxy* track_proxy) const;
    /// @}
 
    /// @name IExtension interface implementation
    /// @{
    virtual string GetExtensionIdentifier() const;
    virtual string GetExtensionLabel() const;
    /// @}
};
 
///////////////////////////////////////////////////////////////////////////////
///   CBinsTrack inline methods
///////////////////////////////////////////////////////////////////////////////
inline /*virtual*/
CRef<CSGGenBankDS> CBinsTrack::GetDataSource()
{
    return CRef<CSGGenBankDS>(m_DS.GetPointer());
}
 
inline /*virtual*/
CConstRef<CSGGenBankDS> CBinsTrack::GetDataSource() const
{
    return CConstRef<CSGGenBankDS>(m_DS.GetPointer());
}
 
 
END_NCBI_SCOPE
 
#endif  // GUI_PACKAGES_SNP_BINS_TRACK__BINS_TRACK__HPP