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

Search Toolkit Book for CInterfaceRegistry

#include <gui/objutils/interface_registry.hpp>

+ Inheritance diagram for CInterfaceRegistry:
+ Collaboration diagram for CInterfaceRegistry:

Static Public Member Functions

static void RegisterFactory (const string &interface_name, IInterfaceFactory *factory)
 
static void RegisterFactory (const string &interface_name, IObjectInterfaceFactory *factory)
 
static void RegisterFactory (const string &interface_name, TTypeInfo info, IInterfaceFactory *factory)
 
static void RegisterFactory (const string &interface_name, TTypeInfo info, IObjectInterfaceFactory *factory)
 
static CObjectCreateInterface (const string &interface_name, TTypeInfo info, ICreateParams *params)
 
static CObjectCreateInterface (const string &interface_name, SConstScopedObject &object, ICreateParams *params)
 
static bool ObjectHasInterface (const string &interface_name, SConstScopedObject &object)
 
- 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)
 

Private Types

typedef map< string, CRef< IInterfaceFactory > > TIfFactoryMap
 
typedef map< string, CRef< IObjectInterfaceFactory > > TIfObjectFactoryMap
 
typedef map< TTypeInfo, TIfFactoryMapTTypeIfFactoryMap
 
typedef map< TTypeInfo, TIfObjectFactoryMapTTypeIfObjectFactoryMap
 

Private Member Functions

 CInterfaceRegistry ()
 

Static Private Member Functions

static CInterfaceRegistryx_GetInstance ()
 

Private Attributes

TTypeIfFactoryMap m_Interfaces
 
TTypeIfObjectFactoryMap m_ObjectInterfaces
 

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

Definition at line 78 of file interface_registry.hpp.

Member Typedef Documentation

◆ TIfFactoryMap

Definition at line 97 of file interface_registry.hpp.

◆ TIfObjectFactoryMap

Definition at line 98 of file interface_registry.hpp.

◆ TTypeIfFactoryMap

Definition at line 100 of file interface_registry.hpp.

◆ TTypeIfObjectFactoryMap

Definition at line 101 of file interface_registry.hpp.

Constructor & Destructor Documentation

◆ CInterfaceRegistry()

CInterfaceRegistry::CInterfaceRegistry ( )
inlineprivate

Definition at line 104 of file interface_registry.hpp.

Member Function Documentation

◆ CreateInterface() [1/2]

CObject * CInterfaceRegistry::CreateInterface ( const string interface_name,
SConstScopedObject object,
ICreateParams params 
)
static

◆ CreateInterface() [2/2]

CObject * CInterfaceRegistry::CreateInterface ( const string interface_name,
TTypeInfo  info,
ICreateParams params 
)
static

◆ ObjectHasInterface()

bool CInterfaceRegistry::ObjectHasInterface ( const string interface_name,
SConstScopedObject object 
)
static

◆ RegisterFactory() [1/4]

void CInterfaceRegistry::RegisterFactory ( const string interface_name,
IInterfaceFactory factory 
)
static

◆ RegisterFactory() [2/4]

void CInterfaceRegistry::RegisterFactory ( const string interface_name,
IObjectInterfaceFactory factory 
)
static

Definition at line 45 of file interface_registry.cpp.

References NULL, and RegisterFactory().

◆ RegisterFactory() [3/4]

void CInterfaceRegistry::RegisterFactory ( const string interface_name,
TTypeInfo  info,
IInterfaceFactory factory 
)
static

Definition at line 50 of file interface_registry.cpp.

References info, m_Interfaces, and x_GetInstance().

◆ RegisterFactory() [4/4]

void CInterfaceRegistry::RegisterFactory ( const string interface_name,
TTypeInfo  info,
IObjectInterfaceFactory factory 
)
static

Definition at line 58 of file interface_registry.cpp.

References info, m_ObjectInterfaces, and x_GetInstance().

◆ x_GetInstance()

CInterfaceRegistry & CInterfaceRegistry::x_GetInstance ( )
staticprivate

Definition at line 153 of file interface_registry.cpp.

Referenced by CreateInterface(), ObjectHasInterface(), and RegisterFactory().

Member Data Documentation

◆ m_Interfaces

TTypeIfFactoryMap CInterfaceRegistry::m_Interfaces
private

Definition at line 106 of file interface_registry.hpp.

Referenced by CreateInterface(), and RegisterFactory().

◆ m_ObjectInterfaces

TTypeIfObjectFactoryMap CInterfaceRegistry::m_ObjectInterfaces
private

Definition at line 107 of file interface_registry.hpp.

Referenced by CreateInterface(), ObjectHasInterface(), and RegisterFactory().


The documentation for this class was generated from the following files:
Modified on Sat Dec 09 04:49:53 2023 by modify_doxy.py rev. 669887