NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
CUIDataSourceService Class Reference

Search Toolkit Book for CUIDataSourceService

CUIDataSourceService. More...

#include <gui/core/ui_data_source_service.hpp>

+ Inheritance diagram for CUIDataSourceService:
+ Collaboration diagram for CUIDataSourceService:

Public Types

typedef CIRef< IUIDataSourceTypeTUIDataSourceTypeRef
 
typedef vector< TUIDataSourceTypeRefTDataSourceTypeVec
 
typedef CIRef< IUIDataSourceTUIDataSourceRef
 
typedef vector< TUIDataSourceRefTUIDataSourceVec
 
typedef CIRef< IUIToolManagerTUIToolManagerRef
 
typedef vector< TUIToolManagerRefTUIToolManagerVec
 
- 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 Member Functions

 CUIDataSourceService ()
 CUIDataSourceService. More...
 
 ~CUIDataSourceService ()
 
virtual void GetDataSourceTypes (TDataSourceTypeVec &type_vec)
 
virtual TUIDataSourceTypeRef GetUIDataSourceTypeByLabel (const string &label)
 finds a Data Source Type by its UI label More...
 
virtual void AddDataSource (IUIDataSource &data_source)
 registers a new data source More...
 
virtual void GetDataSources (TUIDataSourceVec &data_sources)
 retrieve Data Sources registered in the application More...
 
virtual TUIDataSourceRef GetUIDataSourceByLabel (const string &label)
 finds a Data Source by its UI label More...
 
virtual void GetLoadManagers (TUIToolManagerVec &managers)
 retrieve Load Managers (both system Managers the Data Sources Managers) More...
 
IService implementation
virtual void InitService ()
 
virtual void ShutDownService ()
 
IServiceLocatorConsumer implementation
virtual void SetServiceLocator (IServiceLocator *locator)
 
IRegSettings interface implementation
virtual void SetRegistryPath (const string &path)
 
virtual void SaveSettings () const
 
virtual void LoadSettings ()
 
- 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 IService
virtual ~IService ()
 
- Public Member Functions inherited from IServiceLocatorConsumer
virtual ~IServiceLocatorConsumer ()
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Protected Member Functions

void x_InitDataSourceTypes ()
 
void x_InitDefaultDataSources ()
 
void x_InitLoadManagers ()
 
virtual void x_OpenDataSources ()
 
void x_CloseDataSources ()
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

IServiceLocatorm_SrvLocator
 
string m_RegPath
 
TDataSourceTypeVec m_DataSourceTypes
 
TUIDataSourceVec m_DataSources
 
TUIToolManagerVec m_LoadManagers
 

Private Member Functions

 CUIDataSourceService (const CUIDataSourceService &)
 
CUIDataSourceServiceoperator= (const CUIDataSourceService &)
 

Private Attributes

IExtensionm_OptionsDlgPage
 

Additional Inherited Members

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

Detailed Description

CUIDataSourceService.

Definition at line 64 of file ui_data_source_service.hpp.

Member Typedef Documentation

◆ TDataSourceTypeVec

Definition at line 72 of file ui_data_source_service.hpp.

◆ TUIDataSourceRef

Definition at line 74 of file ui_data_source_service.hpp.

◆ TUIDataSourceTypeRef

Definition at line 71 of file ui_data_source_service.hpp.

◆ TUIDataSourceVec

Definition at line 75 of file ui_data_source_service.hpp.

◆ TUIToolManagerRef

Definition at line 77 of file ui_data_source_service.hpp.

◆ TUIToolManagerVec

Definition at line 78 of file ui_data_source_service.hpp.

Constructor & Destructor Documentation

◆ CUIDataSourceService() [1/2]

CUIDataSourceService::CUIDataSourceService ( )

CUIDataSourceService.

Definition at line 55 of file ui_data_source_service.cpp.

◆ ~CUIDataSourceService()

CUIDataSourceService::~CUIDataSourceService ( )

Definition at line 61 of file ui_data_source_service.cpp.

◆ CUIDataSourceService() [2/2]

CUIDataSourceService::CUIDataSourceService ( const CUIDataSourceService )
private

Member Function Documentation

◆ AddDataSource()

void CUIDataSourceService::AddDataSource ( IUIDataSource data_source)
virtual

registers a new data source

Definition at line 209 of file ui_data_source_service.cpp.

References eUnknown, IUIDataSource::GetDescr(), IUIObject::GetLabel(), Info(), LOG_POST, m_DataSources, and NCBI_THROW.

Referenced by x_InitDefaultDataSources().

◆ GetDataSources()

void CUIDataSourceService::GetDataSources ( TUIDataSourceVec data_sources)
virtual

retrieve Data Sources registered in the application

Definition at line 246 of file ui_data_source_service.cpp.

References m_DataSources.

Referenced by PT::CRoot::UpdateDataSources().

◆ GetDataSourceTypes()

void CUIDataSourceService::GetDataSourceTypes ( TDataSourceTypeVec type_vec)
virtual

Definition at line 227 of file ui_data_source_service.cpp.

References m_DataSourceTypes.

Referenced by CDataSourcesPage::CreateControls().

◆ GetLoadManagers()

void CUIDataSourceService::GetLoadManagers ( TUIToolManagerVec managers)
virtual

retrieve Load Managers (both system Managers the Data Sources Managers)

Definition at line 265 of file ui_data_source_service.cpp.

References m_LoadManagers.

◆ GetUIDataSourceByLabel()

CUIDataSourceService::TUIDataSourceRef CUIDataSourceService::GetUIDataSourceByLabel ( const string label)
virtual

finds a Data Source by its UI label

Definition at line 253 of file ui_data_source_service.cpp.

References i, label, and m_DataSources.

◆ GetUIDataSourceTypeByLabel()

CUIDataSourceService::TUIDataSourceTypeRef CUIDataSourceService::GetUIDataSourceTypeByLabel ( const string label)
virtual

finds a Data Source Type by its UI label

Definition at line 234 of file ui_data_source_service.cpp.

References i, label, and m_DataSourceTypes.

◆ InitService()

void CUIDataSourceService::InitService ( )
virtual

◆ LoadSettings()

void CUIDataSourceService::LoadSettings ( )
virtual

Implements IRegSettings.

Definition at line 203 of file ui_data_source_service.cpp.

References _ASSERT, and m_RegPath.

Referenced by InitService().

◆ operator=()

CUIDataSourceService& CUIDataSourceService::operator= ( const CUIDataSourceService )
private

◆ SaveSettings()

void CUIDataSourceService::SaveSettings ( ) const
virtual

Implements IRegSettings.

Definition at line 197 of file ui_data_source_service.cpp.

References _ASSERT, and m_RegPath.

Referenced by ShutDownService().

◆ SetRegistryPath()

void CUIDataSourceService::SetRegistryPath ( const string path)
virtual

Implements IRegSettings.

Definition at line 192 of file ui_data_source_service.cpp.

References m_RegPath.

◆ SetServiceLocator()

void CUIDataSourceService::SetServiceLocator ( IServiceLocator locator)
virtual

Implements IServiceLocatorConsumer.

Definition at line 186 of file ui_data_source_service.cpp.

References m_SrvLocator.

◆ ShutDownService()

void CUIDataSourceService::ShutDownService ( )
virtual

◆ x_CloseDataSources()

void CUIDataSourceService::x_CloseDataSources ( )
protected

◆ x_InitDataSourceTypes()

void CUIDataSourceService::x_InitDataSourceTypes ( )
protected

◆ x_InitDefaultDataSources()

void CUIDataSourceService::x_InitDefaultDataSources ( )
protected

◆ x_InitLoadManagers()

void CUIDataSourceService::x_InitLoadManagers ( )
protected

◆ x_OpenDataSources()

void CUIDataSourceService::x_OpenDataSources ( )
protectedvirtual

Member Data Documentation

◆ m_DataSources

TUIDataSourceVec CUIDataSourceService::m_DataSources
protected

◆ m_DataSourceTypes

TDataSourceTypeVec CUIDataSourceService::m_DataSourceTypes
protected

◆ m_LoadManagers

TUIToolManagerVec CUIDataSourceService::m_LoadManagers
protected

◆ m_OptionsDlgPage

IExtension* CUIDataSourceService::m_OptionsDlgPage
private

Definition at line 140 of file ui_data_source_service.hpp.

Referenced by InitService(), and ShutDownService().

◆ m_RegPath

string CUIDataSourceService::m_RegPath
protected

◆ m_SrvLocator

IServiceLocator* CUIDataSourceService::m_SrvLocator
protected

Definition at line 128 of file ui_data_source_service.hpp.

Referenced by SetServiceLocator(), and x_InitDefaultDataSources().


The documentation for this class was generated from the following files:
Modified on Tue May 28 05:51:03 2024 by modify_doxy.py rev. 669887