NCBI C++ ToolKit
splign_tool.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef PKG_ALIGNMENT___SPLIGN_TOOL__HPP
2 #define PKG_ALIGNMENT___SPLIGN_TOOL__HPP
3 
4 /* $Id: splign_tool.hpp 46706 2021-09-09 19:54:51Z asztalos $
5 * ===========================================================================
6 *
7 * PUBLIC DOMAIN NOTICE
8 * National Center for Biotechnology Information
9 *
10 * This software/database is a "United States Government Work" under the
11 * terms of the United States Copyright Act. It was written as part of
12 * the author's official duties as a United States Government employee and
13 * thus cannot be copyrighted. This software/database is freely available
14 * to the public for use. The National Library of Medicine and the U.S.
15 * Government have not placed any restriction on its use or reproduction.
16 *
17 * Although all reasonable efforts have been taken to ensure the accuracy
18 * and reliability of the software and data, the NLM and the U.S.
19 * Government do not and cannot warrant the performance or results that
20 * may be obtained by using this software or data. The NLM and the U.S.
21 * Government disclaim all warranties, express or implied, including
22 * warranties of performance, merchantability or fitness for any particular
23 * purpose.
24 *
25 * Please cite the author in any work or product based on this material.
26 *
27 * ===========================================================================
28 *
29 * Authors: Roman Katargin
30 *
31 * File Description:
32 * Implementation of "SPLIGN" tool for GenomeWorkbench.
33 */
34 
35 #include <corelib/ncbistd.hpp>
36 
38 
40 
42 
43 /** @addtogroup GUI_PKG_ALIGNMENT
44  *
45  * @{
46  */
47 
48 class CSplignPanel;
49 
50 ///////////////////////////////////////////////////////////////////////////////
51 /// CSplignTool
53 {
54 public:
55  CSplignTool();
56 
57  /// @name overriding IUIToolManager functions implemented in CAlgoToolManagerBase
58  /// @{
59  virtual void InitUI();
60  virtual void CleanUI();
61  virtual wxPanel* GetMaxPanel();
62  /// @}
63 
64  /// @name IExtension interface implementation
65  /// @{
66  virtual string GetExtensionIdentifier() const;
67  virtual string GetExtensionLabel() const;
68  /// @}
69 
70 protected:
71  /// @name overriding CAlgoToolManagerBase virtual functions
72  /// @{
75  virtual bool x_CreateParamsPanelIfNeeded();
76  virtual bool x_ValidateParams();
78  virtual bool CanQuickLaunch() const { return true; }
79  virtual IAppTask* QuickLaunch();
80  /// @}
81 
82  virtual void x_SelectCompatibleInputObjects();
83 
84 protected:
86 
91 };
92 
93 /* @} */
94 
96 
97 #endif // PKG_ALIGNMENT___SPLIGN_TOOL__HPP
CAlgoToolManagerBase This is base class for simple algorithmic tool managers.
CAlgoToolManagerParamsPanel.
CDataLoadingAppJob - a base class for Jobs loading data into projects.
CSplignTool.
Definition: splign_tool.hpp:53
IAppTask.
Definition: app_task.hpp:83
IRegSettings An interface for objects that save / restore settings using CGuiRegistry.
Include a standard set of the NCBI C++ Toolkit most basic headers.
CSplignTool()
CSplignTool.
Definition: splign_tool.cpp:62
virtual string GetExtensionIdentifier() const
returns the unique human-readable identifier for the extension the id should use lowercase letters se...
Definition: splign_tool.cpp:73
TObjects m_NAObjects
Definition: splign_tool.hpp:88
virtual void CleanUI()
override this function in a derived class and clean extra members
Definition: splign_tool.cpp:91
virtual CDataLoadingAppJob * x_CreateLoadingJob()
factory method for creating the job that executes the tool algorithm override in derived classes
virtual void x_SelectCompatibleInputObjects()
virtual CAlgoToolManagerParamsPanel * x_GetParamsPanel()
returns a pointer to the parameters panel, override in derived classes
virtual bool x_ValidateParams()
validates user input in Parameters panel, report errors if any
CSplignParams m_Params
Definition: splign_tool.hpp:89
CSplignPanel * m_Panel
Definition: splign_tool.hpp:90
virtual IAppTask * QuickLaunch()
TObjects m_GenomicObjects
Definition: splign_tool.hpp:87
virtual wxPanel * GetMaxPanel()
Return the panel that occupies max size on display, to calculate dialog window size.
virtual IRegSettings * x_GetParamsAsRegSetting()
return a pointer to Parameters object as IRegSettings interface
virtual bool CanQuickLaunch() const
Definition: splign_tool.hpp:78
virtual void InitUI()
override this function in a derived class and initialize extra members
Definition: splign_tool.cpp:84
virtual bool x_CreateParamsPanelIfNeeded()
returns / creates Parameters panel, override in derived classes see cpp file for example
Definition: splign_tool.cpp:97
map< string, TConstScopedObjects > TObjects
Definition: splign_tool.hpp:85
virtual string GetExtensionLabel() const
returns a displayable label for this extension ( please capitalize the key words - "My Extension" )
Definition: splign_tool.cpp:79
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Modified on Sat Feb 24 07:48:39 2024 by modify_doxy.py rev. 669887