NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
CTableFileLoadManager Class Reference

Search Toolkit Book for CTableFileLoadManager

CTableFileLoadManager. More...

#include <gui/core/table_file_load_manager.hpp>

+ Inheritance diagram for CTableFileLoadManager:
+ Collaboration diagram for CTableFileLoadManager:

Public Member Functions

 CTableFileLoadManager ()
 CTableFileLoadManager. More...
 
IFileLoadPanelClient interface implementation
virtual string GetLabel () const
 
virtual wxString GetFormatWildcard () const
 return file wildcard for the format (example - "*.txt;*.tab" ) More...
 
virtual string GetFileLoaderId () const
 
IUILoadManager interface implementation
virtual void SetServiceLocator (IServiceLocator *srv_locator)
 Sets / unsets Service Locator. More...
 
virtual void SetParentWindow (wxWindow *parent)
 
virtual const IUIObjectGetDescriptor () const
 Returns the object describing this tool (UI meta data). More...
 
virtual void InitUI ()
 Initializes the Manager before using it in UI. More...
 
virtual void CleanUI ()
 CleanUI() is called after the host finished using the manager. More...
 
virtual wxPanel * GetCurrentPanel ()
 Return the panel corresponding to the current state of Tool Manager. More...
 
virtual bool CanDo (EAction action)
 Indicates whether given transition is possible in the current state. More...
 
virtual bool IsFinalState ()
 True if Tool Manager has reached its final state, i.e. More...
 
virtual bool IsCompletedState ()
 Manager goes into "Complete" state when "Finish" button is pressed and all input data is gatherred and validated. More...
 
virtual bool DoTransition (EAction action)
 Performs 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. More...
 
virtual bool SingleFileLoader () const
 returns true if loader can handle only one file More...
 
virtual IWizardPageGetFirstPage ()
 Returns first options page (if any) of the tool to be shown in wizard dialog. More...
 
virtual void SetPrevPage (IWizardPage *prevPage)
 Sets a wizard page which should show before the first page of the tool. More...
 
virtual IAppTaskGetTask ()
 Once 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. More...
 
virtual IExecuteUnitGetExecuteUnit ()
 
virtual wxString GetFormatWildcard ()
 
virtual bool ValidateFilenames (const vector< wxString > &filenames)
 checks given filenames and returns true if the manager can handle them, otherwise - shows an error message More...
 
virtual void SetFilenames (const vector< wxString > &filenames)
 initilize the manager with the given filenames More...
 
virtual void GetFilenames (vector< wxString > &filenames) const
 get actual filenames that will be opened More...
 
virtual bool IsInitialState ()
 return true if the current state of the loader UI is the first valid state (first step in a wizard-like sequence) More...
 
virtual bool RecognizeFormat (const wxString &filename)
 return true if the given file format is supported by this manager More...
 
virtual bool RecognizeFormat (CFormatGuess::EFormat fmt)
 return true if the given file format is supported by this manager More...
 
IExtension interface implementation
virtual string GetExtensionIdentifier () const
 returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this" More...
 
virtual string GetExtensionLabel () const
 returns a displayable label for this extension ( please capitalize the key words - "My Extension" ) More...
 
IRegSettings interface implementation
virtual void SetRegistryPath (const string &path)
 
virtual void LoadSettings ()
 
virtual void SaveSettings () const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 
- Public Member Functions inherited from IFileFormatLoaderManager
virtual bool CanGuessFormat () const
 returns true if loader's format can be guessed More...
 
- Public Member Functions inherited from IUIToolManager
virtual wxPanel * GetMaxPanel ()
 Return the panel that occupies max size on display, to calculate dialog window size. More...
 
virtual IUIToolManagerGetAlternateToolManager ()
 If a transition fails, it may make sense to switch to a different tool manger When a tool manager identifies a more appropriate manager for a task, it returns it here, otherwise NULL. More...
 
virtual IWizardPageGetOptionsPage ()
 Returns page for tool options (long wizard path via "Options" button) More...
 
virtual void SetNextPage (IWizardPage *)
 Sets a wizard page which should show after the last page of the tool. More...
 
virtual void RestoreDefaults ()
 Restores the default options for the current panel. More...
 
virtual void ResetState ()
 
virtual bool UsesSingleOMScope ()
 
virtual ~IUIToolManager ()
 
- Public Member Functions inherited from IFileLoadPanelClient
virtual ~IFileLoadPanelClient ()
 
- Public Member Functions inherited from IToolWizard
virtual ~IToolWizard ()
 
virtual IWizardPageGetOptionsPage ()
 Returns page for tool options (long wizard path via "Options" button) More...
 
virtual void SetNextPage (IWizardPage *)
 Sets a wizard page which should show after the last page of the tool. More...
 
- Public Member Functions inherited from IExtension
virtual ~IExtension ()
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Static Public Member Functions

static string Id ()
 
static string Label ()
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Protected Attributes

CUIObject m_Descr
 
IServiceLocatorm_SrvLocator
 
vector< wxString > m_FileNames
 
CTableImportWizard m_Wizard
 

Additional Inherited Members

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Public Types inherited from IUIToolManager
enum  EAction { eBack = 0 , eNext , eSkip }
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CTableFileLoadManager.

CTableFileLoadManager - a Load Manager for table files. This class implements IFileFormatLoaderManager interface in order to work with generic Format Load Manager.

Definition at line 57 of file table_file_load_manager.hpp.

Constructor & Destructor Documentation

◆ CTableFileLoadManager()

CTableFileLoadManager::CTableFileLoadManager ( )

Member Function Documentation

◆ CanDo()

bool CTableFileLoadManager::CanDo ( EAction  action)
virtual

Indicates whether given transition is possible in the current state.

Implements IUIToolManager.

Definition at line 119 of file table_file_load_manager.cpp.

References _ASSERT, IUIToolManager::eBack, IUIToolManager::eNext, IsCompletedState(), and IsInitialState().

◆ CleanUI()

void CTableFileLoadManager::CleanUI ( )
virtual

CleanUI() is called after the host finished using the manager.

This function shall free resources associated with the session and reset internal state.

Implements IUIToolManager.

Definition at line 94 of file table_file_load_manager.cpp.

References CTableImportWizard::CleanUI(), and m_Wizard.

◆ DoTransition()

bool CTableFileLoadManager::DoTransition ( EAction  action)
virtual

Performs 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.

Definition at line 148 of file table_file_load_manager.cpp.

References _ASSERT, IUIToolManager::eBack, IUIToolManager::eNext, CTableImportWizard::GoNextPage(), CTableImportWizard::GoPrevPage(), and m_Wizard.

◆ GetCurrentPanel()

wxPanel * CTableFileLoadManager::GetCurrentPanel ( )
virtual

Return the panel corresponding to the current state of Tool Manager.

Implements IUIToolManager.

Definition at line 100 of file table_file_load_manager.cpp.

References CTableImportWizard::GetCurrentPanel(), and m_Wizard.

◆ GetDescriptor()

const IUIObject & CTableFileLoadManager::GetDescriptor ( ) const
virtual

Returns the object describing this tool (UI meta data).

Implements IUIToolManager.

Definition at line 82 of file table_file_load_manager.cpp.

References m_Descr.

◆ GetExecuteUnit()

IExecuteUnit * CTableFileLoadManager::GetExecuteUnit ( )
virtual

Reimplemented from IFileLoadPanelClient.

Definition at line 169 of file table_file_load_manager.cpp.

References CTableImportWizard::GetExecuteUnit(), m_FileNames, and m_Wizard.

◆ GetExtensionIdentifier()

string CTableFileLoadManager::GetExtensionIdentifier ( ) const
virtual

returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this"

Implements IExtension.

Definition at line 215 of file table_file_load_manager.cpp.

◆ GetExtensionLabel()

string CTableFileLoadManager::GetExtensionLabel ( ) const
virtual

returns a displayable label for this extension ( please capitalize the key words - "My Extension" )

Implements IExtension.

Definition at line 222 of file table_file_load_manager.cpp.

◆ GetFileLoaderId()

virtual string CTableFileLoadManager::GetFileLoaderId ( ) const
inlinevirtual

Implements IFileFormatLoaderManager.

Definition at line 72 of file table_file_load_manager.hpp.

References Id().

◆ GetFilenames()

void CTableFileLoadManager::GetFilenames ( vector< wxString > &  filenames) const
virtual

get actual filenames that will be opened

Implements IFileFormatLoaderManager.

Definition at line 192 of file table_file_load_manager.cpp.

References filenames, and m_FileNames.

◆ GetFirstPage()

virtual IWizardPage* CTableFileLoadManager::GetFirstPage ( )
inlinevirtual

Returns first options page (if any) of the tool to be shown in wizard dialog.

Reimplemented from IToolWizard.

Definition at line 88 of file table_file_load_manager.hpp.

References CTableImportWizard::GetFirstPage(), and m_Wizard.

◆ GetFormatWildcard() [1/2]

wxString CTableFileLoadManager::GetFormatWildcard ( )
virtual

◆ GetFormatWildcard() [2/2]

wxString CTableFileLoadManager::GetFormatWildcard ( ) const
virtual

return file wildcard for the format (example - "*.txt;*.tab" )

Implements IFileLoadPanelClient.

Definition at line 60 of file table_file_load_manager.cpp.

References CFileExtensions::GetDialogFilter(), CFileExtensions::kAllFiles, CFileExtensions::kTable, and wxT.

◆ GetLabel()

string CTableFileLoadManager::GetLabel ( void  ) const
virtual

Implements IFileLoadPanelClient.

Definition at line 55 of file table_file_load_manager.cpp.

References CUIObject::GetLabel(), and m_Descr.

◆ GetTask()

IAppTask * CTableFileLoadManager::GetTask ( )
virtual

Once 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.

Definition at line 164 of file table_file_load_manager.cpp.

◆ Id()

static string CTableFileLoadManager::Id ( )
inlinestatic

Definition at line 118 of file table_file_load_manager.hpp.

Referenced by GetFileLoaderId().

◆ InitUI()

void CTableFileLoadManager::InitUI ( )
virtual

Initializes the Manager before using it in UI.

This function shall reset Internal state of the tool.

Implements IUIToolManager.

Definition at line 88 of file table_file_load_manager.cpp.

References CTableImportWizard::InitUI(), and m_Wizard.

◆ IsCompletedState()

bool CTableFileLoadManager::IsCompletedState ( )
virtual

Manager 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 142 of file table_file_load_manager.cpp.

References CTableImportWizard::IsCompletedState(), and m_Wizard.

Referenced by CanDo().

◆ IsFinalState()

bool CTableFileLoadManager::IsFinalState ( )
virtual

True if Tool Manager has reached its final state, i.e.

the last page (panel) in the sequence is displayed and "Finish" button is shown. The framework calls this function to decide whether Finish or Next button needs to be shown.

Implements IUIToolManager.

Definition at line 136 of file table_file_load_manager.cpp.

References m_Wizard, and CTableImportWizard::OnLastPage().

◆ IsInitialState()

bool CTableFileLoadManager::IsInitialState ( )
virtual

return true if the current state of the loader UI is the first valid state (first step in a wizard-like sequence)

Implements IFileFormatLoaderManager.

Definition at line 197 of file table_file_load_manager.cpp.

References m_Wizard, and CTableImportWizard::OnFirstPage().

Referenced by CanDo().

◆ Label()

static string CTableFileLoadManager::Label ( )
inlinestatic

Definition at line 119 of file table_file_load_manager.hpp.

◆ LoadSettings()

void CTableFileLoadManager::LoadSettings ( )
virtual

Implements IRegSettings.

Definition at line 115 of file table_file_load_manager.cpp.

◆ RecognizeFormat() [1/2]

bool CTableFileLoadManager::RecognizeFormat ( CFormatGuess::EFormat  fmt)
virtual

return true if the given file format is supported by this manager

Implements IFileFormatLoaderManager.

Definition at line 210 of file table_file_load_manager.cpp.

References CFormatGuess::eTable.

◆ RecognizeFormat() [2/2]

bool CTableFileLoadManager::RecognizeFormat ( const wxString &  filename)
virtual

return true if the given file format is supported by this manager

Implements IFileFormatLoaderManager.

Definition at line 203 of file table_file_load_manager.cpp.

References CFileExtensions::kTable, and CFileExtensions::RecognizeExtension().

◆ SaveSettings()

void CTableFileLoadManager::SaveSettings ( ) const
virtual

Implements IRegSettings.

Definition at line 110 of file table_file_load_manager.cpp.

◆ SetFilenames()

void CTableFileLoadManager::SetFilenames ( const vector< wxString > &  filenames)
virtual

initilize the manager with the given filenames

Implements IFileFormatLoaderManager.

Definition at line 187 of file table_file_load_manager.cpp.

References filenames, and m_FileNames.

◆ SetParentWindow()

void CTableFileLoadManager::SetParentWindow ( wxWindow *  parent)
virtual

Implements IToolWizard.

Definition at line 76 of file table_file_load_manager.cpp.

References m_Wizard, and CTableImportWizard::SetParentWindow().

◆ SetPrevPage()

virtual void CTableFileLoadManager::SetPrevPage ( IWizardPage )
inlinevirtual

Sets a wizard page which should show before the first page of the tool.

Reimplemented from IToolWizard.

Definition at line 89 of file table_file_load_manager.hpp.

References m_Wizard, and CTableImportWizard::SetPrevPage().

◆ SetRegistryPath()

void CTableFileLoadManager::SetRegistryPath ( const string path)
virtual

Implements IRegSettings.

Definition at line 105 of file table_file_load_manager.cpp.

References m_Wizard, and CTableImportWizard::SetRegistryPath().

◆ SetServiceLocator()

void CTableFileLoadManager::SetServiceLocator ( IServiceLocator srv_locator)
virtual

Sets / unsets Service Locator.

Tool Manager can use the locator to obtain the services necessary services.

Implements IUIToolManager.

Definition at line 70 of file table_file_load_manager.cpp.

References m_SrvLocator.

◆ SingleFileLoader()

virtual bool CTableFileLoadManager::SingleFileLoader ( ) const
inlinevirtual

returns true if loader can handle only one file

Reimplemented from IFileFormatLoaderManager.

Definition at line 87 of file table_file_load_manager.hpp.

◆ ValidateFilenames()

bool CTableFileLoadManager::ValidateFilenames ( const vector< wxString > &  filenames)
virtual

checks given filenames and returns true if the manager can handle them, otherwise - shows an error message

Implements IFileFormatLoaderManager.

Definition at line 181 of file table_file_load_manager.cpp.

References filenames, m_Wizard, and CTableImportWizard::ValidateFilenames().

Member Data Documentation

◆ m_Descr

CUIObject CTableFileLoadManager::m_Descr
protected

Definition at line 122 of file table_file_load_manager.hpp.

Referenced by CTableFileLoadManager(), GetDescriptor(), and GetLabel().

◆ m_FileNames

vector<wxString> CTableFileLoadManager::m_FileNames
protected

Definition at line 124 of file table_file_load_manager.hpp.

Referenced by GetExecuteUnit(), GetFilenames(), and SetFilenames().

◆ m_SrvLocator

IServiceLocator* CTableFileLoadManager::m_SrvLocator
protected

Definition at line 123 of file table_file_load_manager.hpp.

Referenced by SetServiceLocator().

◆ m_Wizard

CTableImportWizard CTableFileLoadManager::m_Wizard
protected

The documentation for this class was generated from the following files:
Modified on Thu Nov 30 04:52:47 2023 by modify_doxy.py rev. 669887