NCBI C++ ToolKit
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CWinMaskerFileStorage Class Reference

Search Toolkit Book for CWinMaskerFileStorage

#include <gui/widgets/loaders/winmask_files.hpp>

+ Inheritance diagram for CWinMaskerFileStorage:
+ Collaboration diagram for CWinMaskerFileStorage:

Public Member Functions

void SetRegistryPath (const string &path)
 
void SaveSettings () const
 
void LoadSettings ()
 
void GetTaxIds (vector< int > &ids)
 
wxString GetPath () const
 
bool GetUseEnvPath () const
 
void SetUseEnvPath (bool value)
 
wxString GetEnvPath () const
 
wxString GeFtpUrl () const
 
bool ShowOptionsDlg ()
 
bool IsDownloading () const
 
- Public Member Functions inherited from CObjectEx
 CObjectEx (void)
 
virtual ~CObjectEx (void)
 
- 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 CWeakObject
 CWeakObject (void)
 
virtual ~CWeakObject (void)
 
CPtrToObjectProxyGetPtrProxy (void) const
 Get pointer to proxy object containing pointer to this object. More...
 
- Public Member Functions inherited from CEventHandler
 CEventHandler ()
 CEventHandler. More...
 
virtual ~CEventHandler ()
 
virtual void AddListener (CEventHandler *listener, int pool_name=ePool_Default)
 Add a listener. More...
 
virtual void RemoveListener (CEventHandler *listener)
 Remove a listener. More...
 
virtual void RemoveAllListeners (void)
 
virtual bool HasListener (CEventHandler *listener, int pool_name=ePool_Default) const
 returns "true" if the given listener belongs to the specified pool More...
 
virtual const TListenersGetListeners (int pool_name=ePool_Default) const
 returns a set of listeners fro the specified pool More...
 
virtual bool OnEvent (CEvent *evt)
 Processes en event. Returns "true" if event has been processed. More...
 
virtual bool Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Dispatches an event to the listeners (but does not handle it). More...
 
virtual bool Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Sends an event synchronously. More...
 
virtual bool Send (CEvent *evt, int pool_name)
 
void Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)
 Handles an event asynchronously (process and/or dispatch). More...
 

Static Public Member Functions

Singleton maintenance
static CWinMaskerFileStorageGetInstance ()
 access the application-wide singleton More...
 
- 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)
 
- Static Public Member Functions inherited from CEventHandler
static bool HandlePostRequest ()
 
static void ClearPostQueue ()
 erases all events from the queue More...
 
static void DestroyPostQueue ()
 

Private Member Functions

 CWinMaskerFileStorage ()
 
virtual ~CWinMaskerFileStorage ()
 
wxString x_GetDownloadPath () const
 
bool x_ClearDownloads () const
 
void x_DownloadFileList (vector< string > &files)
 
void x_DownloadFiles (const vector< string > &files)
 
void x_OnJobNotification (CEvent *evt)
 
 DECLARE_EVENT_MAP ()
 

Private Attributes

string m_RegPath
 
bool m_UseEnvPath
 
CAppJobDispatcher::TJobID m_JobId
 

Friends

class CWinMaskFilesDlg
 

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 CEventHandler
enum  EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers }
 enum controlling dispatching strategies More...
 
enum  EPoolName {
  ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling ,
  ePool_NextAvailable
}
 Identifiers for standard pools. More...
 
typedef vector< CEventHandler * > TListeners
 
typedef map< int, TListenersTPools
 
typedef list< AutoPtr< SPostRequest > > TPostRequests
 
typedef std::map< CEventHandler *, intTHandlerToCount
 
typedef void(* FOnPostCallback) ()
 
- 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...
 
- Protected Member Functions inherited from CWeakObject
void CleanWeakRefs (void) const
 Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...
 
- Protected Member Functions inherited from CEventHandler
virtual const SEvtMapGetEventMap () const
 
void x_DeclareDead ()
 Removes itself unavailable for async event delivery. More...
 
void x_AddListenerToPool (CEventHandler *listener, int pool_name)
 
- Protected Attributes inherited from CEventHandler
TPools m_Pools
 
- Static Protected Attributes inherited from CEventHandler
static const SEvtMap sm_EvtMap
 

Detailed Description

Definition at line 48 of file winmask_files.hpp.

Constructor & Destructor Documentation

◆ CWinMaskerFileStorage()

CWinMaskerFileStorage::CWinMaskerFileStorage ( )
private

Definition at line 58 of file winmask_files.cpp.

Referenced by GetInstance().

◆ ~CWinMaskerFileStorage()

CWinMaskerFileStorage::~CWinMaskerFileStorage ( )
privatevirtual

Member Function Documentation

◆ DECLARE_EVENT_MAP()

CWinMaskerFileStorage::DECLARE_EVENT_MAP ( )
private

◆ GeFtpUrl()

wxString CWinMaskerFileStorage::GeFtpUrl ( ) const

Definition at line 199 of file winmask_files.cpp.

References kFtpUrl.

Referenced by CWinMaskFilesDlg::CreateControls(), x_DownloadFileList(), and x_DownloadFiles().

◆ GetEnvPath()

wxString CWinMaskerFileStorage::GetEnvPath ( ) const

◆ GetInstance()

CWinMaskerFileStorage & CWinMaskerFileStorage::GetInstance ( void  )
static

◆ GetPath()

wxString CWinMaskerFileStorage::GetPath ( void  ) const

◆ GetTaxIds()

void CWinMaskerFileStorage::GetTaxIds ( vector< int > &  ids)

Definition at line 166 of file winmask_files.cpp.

References GetPath(), and NCBI_CATCH.

◆ GetUseEnvPath()

bool CWinMaskerFileStorage::GetUseEnvPath ( ) const
inline

◆ IsDownloading()

bool CWinMaskerFileStorage::IsDownloading ( ) const
inline

Definition at line 76 of file winmask_files.hpp.

References CAppJobDispatcher::eInvalidJobID, and m_JobId.

Referenced by CWinMaskFilesDlg::OnResetDownloads().

◆ LoadSettings()

void CWinMaskerFileStorage::LoadSettings ( )

◆ SaveSettings()

void CWinMaskerFileStorage::SaveSettings ( ) const

◆ SetRegistryPath()

void CWinMaskerFileStorage::SetRegistryPath ( const string path)

Definition at line 101 of file winmask_files.cpp.

References m_RegPath.

◆ SetUseEnvPath()

void CWinMaskerFileStorage::SetUseEnvPath ( bool  value)
inline

Definition at line 70 of file winmask_files.hpp.

References m_UseEnvPath, and value.

Referenced by CWinMaskFilesDlg::TransferDataFromWindow().

◆ ShowOptionsDlg()

bool CWinMaskerFileStorage::ShowOptionsDlg ( )

◆ x_ClearDownloads()

bool CWinMaskerFileStorage::x_ClearDownloads ( ) const
private

Definition at line 238 of file winmask_files.cpp.

References Error(), LOG_POST, s_RmDir(), and x_GetDownloadPath().

Referenced by CWinMaskFilesDlg::OnResetDownloads().

◆ x_DownloadFileList()

void CWinMaskerFileStorage::x_DownloadFileList ( vector< string > &  files)
private

Definition at line 252 of file winmask_files.cpp.

References GeFtpUrl(), and CFtpUtils::GetDirContent().

◆ x_DownloadFiles()

void CWinMaskerFileStorage::x_DownloadFiles ( const vector< string > &  files)
private

◆ x_GetDownloadPath()

wxString CWinMaskerFileStorage::x_GetDownloadPath ( ) const
private

Definition at line 204 of file winmask_files.cpp.

References CSysPath::ResolvePath(), and wxT.

Referenced by GetPath(), x_ClearDownloads(), and x_DownloadFiles().

◆ x_OnJobNotification()

void CWinMaskerFileStorage::x_OnJobNotification ( CEvent evt)
private

Friends And Related Function Documentation

◆ CWinMaskFilesDlg

friend class CWinMaskFilesDlg
friend

Definition at line 51 of file winmask_files.hpp.

Referenced by ShowOptionsDlg().

Member Data Documentation

◆ m_JobId

CAppJobDispatcher::TJobID CWinMaskerFileStorage::m_JobId
private

◆ m_RegPath

string CWinMaskerFileStorage::m_RegPath
private

Definition at line 87 of file winmask_files.hpp.

Referenced by LoadSettings(), SaveSettings(), and SetRegistryPath().

◆ m_UseEnvPath

bool CWinMaskerFileStorage::m_UseEnvPath
private

Definition at line 88 of file winmask_files.hpp.

Referenced by GetPath(), GetUseEnvPath(), LoadSettings(), SaveSettings(), and SetUseEnvPath().


The documentation for this class was generated from the following files:
Modified on Thu Feb 29 12:19:36 2024 by modify_doxy.py rev. 669887