Search Toolkit Book for CAlgoToolManagerBase
CAlgoToolManagerBase This is base class for simple algorithmic tool managers. More...
#include <gui/core/algo_tool_manager_base.hpp>
CAlgoToolManagerBase This is base class for simple algorithmic tool managers.
The class provides two pages to the Run Tool dialog. 1. Parameters page is for entering tool parameters; derived from CAlgoToolManagerParamsPanel class. 2. Project selection page the standard page for specifying how results shall be added to the workspace - CProjectSelectorPanel. When Finish button is pressed the manager creates a standard CDataLoadingAppTask that executes a job in the background. Derived classed must implement a pure virtual function that creates the job.
Definition at line 67 of file algo_tool_manager_base.hpp.
◆ EStatedefines states of the Tool Manager
Enumerator eInvalid eParams eSelectProject eCompletedDefinition at line 121 of file algo_tool_manager_base.hpp.
◆ CAlgoToolManagerBase() ◆ CanDo() ◆ CanQuickLaunch() virtual bool CAlgoToolManagerBase::CanQuickLaunch ( ) const inlinevirtual ◆ CleanUI() void CAlgoToolManagerBase::CleanUI ( ) virtualoverride this function in a derived class and clean extra members
Implements IUIToolManager.
Reimplemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Definition at line 104 of file algo_tool_manager_base.cpp.
References eInvalid, m_InputObjects, m_ProjectSelPanel, m_State, and NULL.
Referenced by CCleanupAlignmentsToolManager::CleanUI(), CClustalOmegaTool::CleanUI(), CClustalwTool::CleanUI(), CCreateGeneModelToolManager::CleanUI(), CFindOverlapTool::CleanUI(), CGroupAlignmentsToolManager::CleanUI(), CKalignTool::CleanUI(), CMafftTool::CleanUI(), CMergeAlignmentsToolManager::CleanUI(), CMuscleTool::CleanUI(), CNGAlignTool::CleanUI(), CProSplignTool::CleanUI(), CSplignTool::CleanUI(), CCommonTaxTreeTool::CleanUI(), CTreeBuilderTool::CleanUI(), CCleanupTool::CleanUI(), CMergeTool::CleanUI(), CWindowMaskerTool::CleanUI(), CAutodefToolManager::CleanUI(), CDebugMacroTool::CleanUI(), CSrcEditTool::CleanUI(), CAdvancedCleanupTool::CleanUI(), and CCreateNeedlemanWunschToolManager::CleanUI().
◆ DoTransition() bool CAlgoToolManagerBase::DoTransition ( EAction action ) virtualPerforms transition if possible and returns true, otherwise the function shall warn the user about the problem preventing the transition (such as insufficient or invalid input) and return false.
Typically this function would take user input from the current panel, validate the input and go to the next state creating new UI panel if needed.
Implements IUIToolManager.
Reimplemented in CSrcEditTool, CMergeTool, CCleanupTool, and CNGAlignTool.
Definition at line 272 of file algo_tool_manager_base.cpp.
References _ASSERT, ncbi::grid::netcache::search::fields::created, eCompleted, eInvalid, IUIToolManager::eNext, eParams, eSelectProject, CException::GetMsg(), Info(), LOG_POST, m_ProjectSelPanel, m_State, NcbiErrorBox(), next(), CException::ReportAll(), CProjectSelectorPanel::TransferDataFromWindow(), CProjectSelectorPanel::TransferDataToWindow(), x_CreateParamsPanelIfNeeded(), x_CreateProjectPanelIfNeeded(), x_GetParamsPanel(), and x_ValidateParams().
Referenced by CCleanupTool::DoTransition(), CMergeTool::DoTransition(), and CSrcEditTool::DoTransition().
◆ GetCategory() string CAlgoToolManagerBase::GetCategory ( ) virtual ◆ GetCurrentPanel() wxPanel * CAlgoToolManagerBase::GetCurrentPanel ( ) virtual ◆ GetDescriptor() ◆ GetExtensionIdentifier() virtual string CAlgoToolManagerBase::GetExtensionIdentifier ( ) const pure virtualreturns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this"
Implements IExtension.
Implemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
◆ GetExtensionLabel() virtual string CAlgoToolManagerBase::GetExtensionLabel ( ) const pure virtualreturns a displayable label for this extension ( please capitalize the key words - "My Extension" )
Implements IExtension.
Implemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
◆ GetTask() IAppTask * CAlgoToolManagerBase::GetTask ( ) virtualOnce parameters are gathered and validated this function is called to produce the final Task object that will be executed to do the actual computational work.
Implements IUIToolManager.
Reimplemented in CSrcEditTool, CAutodefToolManager, CMergeTool, CCleanupTool, and CCreateGeneModelToolManager.
Definition at line 374 of file algo_tool_manager_base.cpp.
References CProjectSelectorPanel::GetParams(), IServiceLocator::GetServiceByType(), m_ProjectParams, m_ProjectSelPanel, m_SrvLocator, SProjectSelectorParams::ToLoadingOptions(), x_CreateLoadingJob(), and x_GetDataLocker().
◆ InitUI() void CAlgoToolManagerBase::InitUI ( ) virtualoverride this function in a derived class and initialize extra members
Implements IUIToolManager.
Reimplemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Definition at line 92 of file algo_tool_manager_base.cpp.
References eInvalid, m_InputObjects, m_ProjectSelPanel, m_State, and NULL.
Referenced by CCleanupAlignmentsToolManager::InitUI(), CClustalOmegaTool::InitUI(), CClustalwTool::InitUI(), CCreateGeneModelToolManager::InitUI(), CFindOverlapTool::InitUI(), CGroupAlignmentsToolManager::InitUI(), CKalignTool::InitUI(), CMafftTool::InitUI(), CMergeAlignmentsToolManager::InitUI(), CMuscleTool::InitUI(), CNGAlignTool::InitUI(), CProSplignTool::InitUI(), CSplignTool::InitUI(), CCommonTaxTreeTool::InitUI(), CTreeBuilderTool::InitUI(), CCleanupTool::InitUI(), CMergeTool::InitUI(), CWindowMaskerTool::InitUI(), CAutodefToolManager::InitUI(), CDebugMacroTool::InitUI(), CSrcEditTool::InitUI(), CAdvancedCleanupTool::InitUI(), and CCreateNeedlemanWunschToolManager::InitUI().
◆ IsCompletedState() bool CAlgoToolManagerBase::IsCompletedState ( ) virtualManager goes into "Complete" state when "Finish" button is pressed and all input data is gatherred and validated.
Typically this is the last state after Final state. This state does not have an associated UI panel. When manager reaches the Completed state the framework hides the dialog and calls GetTask() function.
Implements IUIToolManager.
Definition at line 266 of file algo_tool_manager_base.cpp.
References eCompleted, and m_State.
◆ IsFinalState() bool CAlgoToolManagerBase::IsFinalState ( ) virtual ◆ LoadSettings() void CAlgoToolManagerBase::LoadSettings ( ) virtual ◆ QuickLaunch() virtual IAppTask* CAlgoToolManagerBase::QuickLaunch ( ) inlinevirtual ◆ RestoreDefaults() void CAlgoToolManagerBase::RestoreDefaults ( ) virtual ◆ SaveSettings() void CAlgoToolManagerBase::SaveSettings ( ) const virtual ◆ SetInputObjects() ◆ SetParentWindow() void CAlgoToolManagerBase::SetParentWindow ( wxWindow * parent ) virtual ◆ SetRegistryPath() void CAlgoToolManagerBase::SetRegistryPath ( const string & path ) virtual ◆ SetServiceLocator() void CAlgoToolManagerBase::SetServiceLocator ( IServiceLocator * srv_locator ) virtual ◆ x_ConvertInputObjects() [1/2]Definition at line 165 of file algo_tool_manager_base.cpp.
References AsyncConvertObjects(), m_InputObjects, NON_CONST_ITERATE, and results.
Referenced by CCleanupAlignmentsToolManager::x_SelectCompatibleInputObjects(), CClustalOmegaTool::x_SelectCompatibleInputObjects(), CClustalwTool::x_SelectCompatibleInputObjects(), CCreateGeneModelToolManager::x_SelectCompatibleInputObjects(), CFindOverlapTool::x_SelectCompatibleInputObjects(), CGroupAlignmentsToolManager::x_SelectCompatibleInputObjects(), CKalignTool::x_SelectCompatibleInputObjects(), CMafftTool::x_SelectCompatibleInputObjects(), CMergeAlignmentsToolManager::x_SelectCompatibleInputObjects(), CMuscleTool::x_SelectCompatibleInputObjects(), CNGAlignTool::x_SelectCompatibleInputObjects(), CProSplignTool::x_SelectCompatibleInputObjects(), CSplignTool::x_SelectCompatibleInputObjects(), CCommonTaxTreeTool::x_SelectCompatibleInputObjects(), CTreeBuilderTool::x_SelectCompatibleInputObjects(), CWindowMaskerTool::x_SelectCompatibleInputObjects(), CAutodefToolManager::x_SelectCompatibleInputObjects(), CDebugMacroTool::x_SelectCompatibleInputObjects(), CAdvancedCleanupTool::x_SelectCompatibleInputObjects(), and CCreateNeedlemanWunschToolManager::x_SelectCompatibleInputObjects().
◆ x_ConvertInputObjects() [2/2] ◆ x_CreateLoadingJob()factory method for creating the job that executes the tool algorithm override in derived classes
Implemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Referenced by GetTask().
◆ x_CreateParamsPanelIfNeeded() virtual bool CAlgoToolManagerBase::x_CreateParamsPanelIfNeeded ( ) protectedpure virtualreturns / creates Parameters panel, override in derived classes see cpp file for example
Implemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Referenced by DoTransition().
◆ x_CreateProjectPanelIfNeeded() void CAlgoToolManagerBase::x_CreateProjectPanelIfNeeded ( ) protectedvirtualreturns / creates Project panel
Reimplemented in CAutodefToolManager.
Definition at line 221 of file algo_tool_manager_base.cpp.
References IServiceLocator::GetServiceByType(), m_ParentWindow, m_ProjectParams, m_ProjectSelPanel, m_SrvLocator, NULL, CProjectSelectorPanel::SetParams(), CProjectSelectorPanel::SetProjectService(), IUIToolManager::UsesSingleOMScope(), and x_InitProjectParams().
Referenced by DoTransition(), and CNGAlignTool::DoTransition().
◆ x_GetDataLocker() ILocker * CAlgoToolManagerBase::x_GetDataLocker ( ) protectedDefinition at line 190 of file algo_tool_manager_base.cpp.
References set< Key, Compare >::begin(), IServiceLocator::GetServiceByType(), CGBDocument::GetUndoManager(), set< Key, Compare >::insert(), ITERATE, m_InputObjects, m_SrvLocator, and set< Key, Compare >::size().
Referenced by GetTask().
◆ x_GetParamsAsRegSetting() virtual IRegSettings* CAlgoToolManagerBase::x_GetParamsAsRegSetting ( ) protectedpure virtualreturn a pointer to Parameters object as IRegSettings interface
Implemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Referenced by LoadSettings(), SaveSettings(), and SetRegistryPath().
◆ x_GetParamsPanel()returns a pointer to the parameters panel, override in derived classes
Implemented in CCreateNeedlemanWunschToolManager, CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Referenced by DoTransition(), GetCurrentPanel(), LoadSettings(), and SaveSettings().
◆ x_InitProjectParams() void CAlgoToolManagerBase::x_InitProjectParams ( ) protectedvirtual ◆ x_SetInputObjects() ◆ x_ValidateInputObjects() string CAlgoToolManagerBase::x_ValidateInputObjects ( ) protectedvirtual ◆ x_ValidateParams() bool CAlgoToolManagerBase::x_ValidateParams ( ) protectedvirtualvalidates user input in Parameters panel, report errors if any
validate parameters after Params page override this function in derived classes
Reimplemented in CAdvancedCleanupTool, CSrcEditTool, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CCleanupTool, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, and CCleanupAlignmentsToolManager.
Definition at line 368 of file algo_tool_manager_base.cpp.
Referenced by DoTransition().
◆ m_Category ◆ m_Descriptor ◆ m_InputObjectsoriginal input objects, the tool needs to select a subset of objects that can serve as valid input
Definition at line 182 of file algo_tool_manager_base.hpp.
Referenced by CleanUI(), InitUI(), x_ConvertInputObjects(), x_GetDataLocker(), x_InitProjectParams(), CCleanupAlignmentsToolManager::x_SelectCompatibleInputObjects(), CCreateGeneModelToolManager::x_SelectCompatibleInputObjects(), CGroupAlignmentsToolManager::x_SelectCompatibleInputObjects(), CMergeAlignmentsToolManager::x_SelectCompatibleInputObjects(), CCleanupTool::x_SelectCompatibleInputObjects(), CMergeTool::x_SelectCompatibleInputObjects(), CSrcEditTool::x_SelectCompatibleInputObjects(), CAdvancedCleanupTool::x_SelectCompatibleInputObjects(), x_SetInputObjects(), and x_ValidateInputObjects().
◆ m_ParentWindow wxWindow* CAlgoToolManagerBase::m_ParentWindow protecteda window that will serve as a parent for our panels
Definition at line 172 of file algo_tool_manager_base.hpp.
Referenced by CClustalOmegaTool::GetMaxPanel(), CClustalwTool::GetMaxPanel(), CKalignTool::GetMaxPanel(), CMafftTool::GetMaxPanel(), CMuscleTool::GetMaxPanel(), CProSplignTool::GetMaxPanel(), CSplignTool::GetMaxPanel(), CCommonTaxTreeTool::GetMaxPanel(), CDebugMacroTool::GetMaxPanel(), CAdvancedCleanupTool::GetMaxPanel(), SetParentWindow(), CNGAlignTool::x_CreateBALSTPanelIfNeeded(), CCleanupAlignmentsToolManager::x_CreateParamsPanelIfNeeded(), CClustalOmegaTool::x_CreateParamsPanelIfNeeded(), CClustalwTool::x_CreateParamsPanelIfNeeded(), CCreateGeneModelToolManager::x_CreateParamsPanelIfNeeded(), CFindOverlapTool::x_CreateParamsPanelIfNeeded(), CGroupAlignmentsToolManager::x_CreateParamsPanelIfNeeded(), CKalignTool::x_CreateParamsPanelIfNeeded(), CMafftTool::x_CreateParamsPanelIfNeeded(), CMergeAlignmentsToolManager::x_CreateParamsPanelIfNeeded(), CMuscleTool::x_CreateParamsPanelIfNeeded(), CNGAlignTool::x_CreateParamsPanelIfNeeded(), CProSplignTool::x_CreateParamsPanelIfNeeded(), CSplignTool::x_CreateParamsPanelIfNeeded(), CCommonTaxTreeTool::x_CreateParamsPanelIfNeeded(), CTreeBuilderTool::x_CreateParamsPanelIfNeeded(), CCleanupTool::x_CreateParamsPanelIfNeeded(), CMergeTool::x_CreateParamsPanelIfNeeded(), CWindowMaskerTool::x_CreateParamsPanelIfNeeded(), CAutodefToolManager::x_CreateParamsPanelIfNeeded(), CDebugMacroTool::x_CreateParamsPanelIfNeeded(), CSrcEditTool::x_CreateParamsPanelIfNeeded(), CAdvancedCleanupTool::x_CreateParamsPanelIfNeeded(), CCreateNeedlemanWunschToolManager::x_CreateParamsPanelIfNeeded(), and x_CreateProjectPanelIfNeeded().
◆ m_ProjectParams ◆ m_ProjectSelPanel ◆ m_RegPath string CAlgoToolManagerBase::m_RegPath protectedregistry path to the settings
Definition at line 175 of file algo_tool_manager_base.hpp.
Referenced by LoadSettings(), SaveSettings(), SetRegistryPath(), CNGAlignTool::x_CreateBALSTPanelIfNeeded(), CCleanupAlignmentsToolManager::x_CreateParamsPanelIfNeeded(), CClustalOmegaTool::x_CreateParamsPanelIfNeeded(), CClustalwTool::x_CreateParamsPanelIfNeeded(), CCreateGeneModelToolManager::x_CreateParamsPanelIfNeeded(), CFindOverlapTool::x_CreateParamsPanelIfNeeded(), CGroupAlignmentsToolManager::x_CreateParamsPanelIfNeeded(), CKalignTool::x_CreateParamsPanelIfNeeded(), CMafftTool::x_CreateParamsPanelIfNeeded(), CMergeAlignmentsToolManager::x_CreateParamsPanelIfNeeded(), CMuscleTool::x_CreateParamsPanelIfNeeded(), CNGAlignTool::x_CreateParamsPanelIfNeeded(), CProSplignTool::x_CreateParamsPanelIfNeeded(), CSplignTool::x_CreateParamsPanelIfNeeded(), CCommonTaxTreeTool::x_CreateParamsPanelIfNeeded(), CTreeBuilderTool::x_CreateParamsPanelIfNeeded(), CCleanupTool::x_CreateParamsPanelIfNeeded(), CMergeTool::x_CreateParamsPanelIfNeeded(), CWindowMaskerTool::x_CreateParamsPanelIfNeeded(), CAutodefToolManager::x_CreateParamsPanelIfNeeded(), CDebugMacroTool::x_CreateParamsPanelIfNeeded(), CSrcEditTool::x_CreateParamsPanelIfNeeded(), CAdvancedCleanupTool::x_CreateParamsPanelIfNeeded(), and CCreateNeedlemanWunschToolManager::x_CreateParamsPanelIfNeeded().
◆ m_SrvLocatorDefinition at line 169 of file algo_tool_manager_base.hpp.
Referenced by GetTask(), CCreateGeneModelToolManager::GetTask(), CCleanupTool::GetTask(), CMergeTool::GetTask(), CSrcEditTool::GetTask(), CKalignTool::QuickLaunch(), CMafftTool::QuickLaunch(), CMuscleTool::QuickLaunch(), CSplignTool::QuickLaunch(), SetServiceLocator(), CAutodefToolManager::x_CreateEditJob(), CDebugMacroTool::x_CreateLoadingJob(), x_CreateProjectPanelIfNeeded(), x_GetDataLocker(), x_InitProjectParams(), CGroupAlignmentsToolManager::x_InitProjectParams(), and CMergeAlignmentsToolManager::x_InitProjectParams().
◆ m_State EState CAlgoToolManagerBase::m_State protectedtool manager state (int the Run Tool wizard)
Definition at line 178 of file algo_tool_manager_base.hpp.
Referenced by CanDo(), CleanUI(), DoTransition(), CNGAlignTool::DoTransition(), CCleanupTool::DoTransition(), CMergeTool::DoTransition(), CSrcEditTool::DoTransition(), GetCurrentPanel(), CNGAlignTool::GetCurrentPanel(), InitUI(), IsCompletedState(), IsFinalState(), CNGAlignTool::IsFinalState(), CCleanupTool::IsFinalState(), CMergeTool::IsFinalState(), and CSrcEditTool::IsFinalState().
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4