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

Go to the SVN repository for this file.

1 #ifndef PKG_SEQUENCE_EDIT__AUTODEF_TOOL_MANAGER__HPP
2 #define PKG_SEQUENCE_EDIT__AUTODEF_TOOL_MANAGER__HPP
3 
4 /* $Id: autodef_tool_manager.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: Colleen Bollin, based on a file by Andrey Yazhuk
30  *
31  * File Description:
32  * Implementation of "Autodef" tool for GenomeWorkbench.
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 #include <gui/gui_export.h>
37 
39 
41 
43 
45 
46 
48 
49 /** @addtogroup GUI_PKG_SEQUENCE
50  *
51  * @{
52  */
53 
54 ///////////////////////////////////////////////////////////////////////////////
55 /// CAutodefToolManager
58 {
59 public:
61 
62  /// @name overriding IUIToolManager functions implemented in CAlgoToolManagerBase
63  /// @{
64  virtual void InitUI();
65  virtual void CleanUI();
66  virtual IAppTask* GetTask();
67  /// @}
68 
69  /// @name IExtension interface implementation
70  /// @{
71  virtual string GetExtensionIdentifier() const;
72  virtual string GetExtensionLabel() const;
73  /// @}
74 
75 protected:
76  /// @name overriding CAlgoToolManagerBase virtual functions
77  /// @{
80  virtual bool x_CreateParamsPanelIfNeeded();
81  virtual bool x_ValidateParams();
82  virtual void x_CreateProjectPanelIfNeeded();
84  /// @}
85 
87  virtual void x_SelectCompatibleInputObjects();
88 
89 protected:
91 
94 };
95 
96 
97 ///////////////////////////////////////////////////////////////////////////////
98 /// CAutodefJob
99 class CAutodefJob : public CEditAppJob
100 {
101 public:
102  CAutodefJob(CProjectService* service, const SAutodefParams& params);
103 
104 protected:
105  virtual void x_MakeChanges();
106 
107 protected:
109 };
110 
111 
112 /* @} */
113 
115 
116 
117 #endif // PKG_SEQUENCE_EDIT__AUTODEF_TOOL_MANAGER__HPP
118 
CAlgoToolManagerBase This is base class for simple algorithmic tool managers.
CAlgoToolManagerParamsPanel.
CAutodefToolManager.
CDataLoadingAppJob - a base class for Jobs loading data into projects.
CEditAppJob - a base class for Jobs modifying existing data in projects.
Definition: edit_job.hpp:59
CProjectService - a service providing API for operations with Workspaces and Projects.
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.
virtual string GetExtensionIdentifier() const
returns the unique human-readable identifier for the extension the id should use lowercase letters se...
virtual bool x_CreateParamsPanelIfNeeded()
returns / creates Parameters panel, override in derived classes see cpp file for example
TConstScopedObjects m_SeqEntries
virtual bool x_ValidateParams()
validates user input in Parameters panel, report errors if any
virtual IRegSettings * x_GetParamsAsRegSetting()
return a pointer to Parameters object as IRegSettings interface
virtual void x_CreateProjectPanelIfNeeded()
returns / creates Project panel
CEditAppJob * x_CreateEditJob()
virtual string GetExtensionLabel() const
returns a displayable label for this extension ( please capitalize the key words - "My Extension" )
SAutodefParams m_Params
virtual void InitUI()
override this function in a derived class and initialize extra members
virtual void CleanUI()
override this function in a derived class and clean extra members
CAutodefToolManager()
CAutodefToolManager.
virtual IAppTask * GetTask()
Once parameters are gathered and validated this function is called to produce the final Task object t...
virtual CDataLoadingAppJob * x_CreateLoadingJob()
factory method for creating the job that executes the tool algorithm override in derived classes
virtual void x_SelectCompatibleInputObjects()
select only Seq-entries
virtual CAlgoToolManagerParamsPanel * x_GetParamsPanel()
returns a pointer to the parameters panel, override in derived classes
virtual void x_MakeChanges()
override this function in derived classes, populate m_TextResult
CAutodefJob(CProjectService *service, const SAutodefParams &params)
CAutodefJob.
CAutodefParamsPanel * m_ParamsPanel
vector< SConstScopedObject > TConstScopedObjects
Definition: objects.hpp:65
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Defines to provide correct exporting from DLLs in Windows.
Modified on Tue May 28 05:53:13 2024 by modify_doxy.py rev. 669887