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

Search Toolkit Book for CVisibleRangeService

CVisibleRangeService. More...

#include <gui/core/visible_range_service_impl.hpp>

+ Inheritance diagram for CVisibleRangeService:
+ Collaboration diagram for CVisibleRangeService:

Public Types

typedef vector< IVisibleRangeClient * > TClients
 
- 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

 CVisibleRangeService ()
 
virtual ~CVisibleRangeService ()
 
void DetachAllClients ()
 
IService interface implementation
virtual void InitService ()
 
virtual void ShutDownService ()
 
IVisibleRangeService implemenation
virtual void AttachClient (IVisibleRangeClient *client)
 
virtual void DetachClient (IVisibleRangeClient *client)
 
virtual void BroadcastVisibleRange (const CVisibleRange &vrange, IVisibleRangeClient *source)
 
IRegSettings 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 IService
virtual ~IService ()
 
- Public Member Functions inherited from IVisibleRangeService
virtual ~IVisibleRangeService ()
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Private Attributes

TClients m_Clients
 
string m_RegPath
 

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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

CVisibleRangeService.

Definition at line 49 of file visible_range_service_impl.hpp.

Member Typedef Documentation

◆ TClients

Definition at line 56 of file visible_range_service_impl.hpp.

Constructor & Destructor Documentation

◆ CVisibleRangeService()

CVisibleRangeService::CVisibleRangeService ( )

Definition at line 41 of file visible_range_service.cpp.

◆ ~CVisibleRangeService()

CVisibleRangeService::~CVisibleRangeService ( )
virtual

Definition at line 45 of file visible_range_service.cpp.

Member Function Documentation

◆ AttachClient()

void CVisibleRangeService::AttachClient ( IVisibleRangeClient client)
virtual

Implements IVisibleRangeService.

Definition at line 69 of file visible_range_service.cpp.

References _ASSERT, client, ERR_POST, and m_Clients.

◆ BroadcastVisibleRange()

void CVisibleRangeService::BroadcastVisibleRange ( const CVisibleRange vrange,
IVisibleRangeClient source 
)
virtual

Implements IVisibleRangeService.

Definition at line 92 of file visible_range_service.cpp.

References _ASSERT, ITERATE, m_Clients, and rapidjson::source.

◆ DetachAllClients()

void CVisibleRangeService::DetachAllClients ( )

Definition at line 49 of file visible_range_service.cpp.

References m_Clients.

Referenced by ShutDownService().

◆ DetachClient()

void CVisibleRangeService::DetachClient ( IVisibleRangeClient client)
virtual

Implements IVisibleRangeService.

Definition at line 81 of file visible_range_service.cpp.

References client, ERR_POST, and m_Clients.

◆ InitService()

void CVisibleRangeService::InitService ( )
virtual

Implements IService.

Definition at line 54 of file visible_range_service.cpp.

References Info(), LoadSettings(), and LOG_POST.

◆ LoadSettings()

void CVisibleRangeService::LoadSettings ( )
virtual

◆ SaveSettings()

void CVisibleRangeService::SaveSettings ( ) const
virtual

◆ SetRegistryPath()

void CVisibleRangeService::SetRegistryPath ( const string path)
virtual

Implements IRegSettings.

Definition at line 109 of file visible_range_service.cpp.

References m_RegPath.

◆ ShutDownService()

void CVisibleRangeService::ShutDownService ( )
virtual

Implements IService.

Definition at line 61 of file visible_range_service.cpp.

References DetachAllClients(), Info(), LOG_POST, and SaveSettings().

Member Data Documentation

◆ m_Clients

TClients CVisibleRangeService::m_Clients
private

◆ m_RegPath

string CVisibleRangeService::m_RegPath
private

Definition at line 87 of file visible_range_service_impl.hpp.

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


The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:08:31 2024 by modify_doxy.py rev. 669887