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

Search Toolkit Book for CRegistryFile

#include <gui/objutils/reg_file.hpp>

+ Inheritance diagram for CRegistryFile:
+ Collaboration diagram for CRegistryFile:

Public Member Functions

 CRegistryFile ()
 
 CRegistryFile (CNcbiIstream &istr)
 
 CRegistryFile (const objects::CUser_object &obj)
 
CRegistryReadView GetReadView (const string &section) const
 
CRegistryWriteView GetWriteView (const string &section)
 
void FromConfigFile (CNcbiIstream &istr)
 
void ToConfigFile (CNcbiOstream &istr) const
 
void Read (CNcbiIstream &istr)
 
void Write (CNcbiOstream &istr) const
 
bool HasField (const string &key) const
 
CConstRef< objects::CUser_field > GetField (const string &key) const
 
CRef< objects::CUser_field > SetField (const string &key)
 
CRef< objects::CUser_field > SetFieldToValue (const string &key)
 
bool DeleteField (const string &key)
 
objects::CUser_object & SetRegistry ()
 
void SetRegistry (const objects::CUser_object &uo)
 precondition: IsRegistry(uo) is true. More...
 
const objects::CUser_object & GetRegistry () 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
 

Static Public Member Functions

static bool IsRegistry (const objects::CUser_object &uo)
 Is this user object suitable to use as a gui-registry site? More...
 
static CRef< objects::CUser_object > NewRegistryObject ()
 make a new user object suitable to use as a gui-registry site. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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 Member Functions

 CRegistryFile (const CRegistryFile &)
 forbidden More...
 
CRegistryFileoperator= (const CRegistryFile &)
 

Private Attributes

CRef< objects::CUser_object > m_Registry
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- 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 43 of file reg_file.hpp.

Constructor & Destructor Documentation

CRegistryFile::CRegistryFile ( )

Definition at line 48 of file reg_file.cpp.

References SetRegistry().

CRegistryFile::CRegistryFile ( CNcbiIstream istr)

Definition at line 54 of file reg_file.cpp.

References Read().

CRegistryFile::CRegistryFile ( const objects::CUser_object &  obj)

Definition at line 60 of file reg_file.cpp.

References SetRegistry().

CRegistryFile::CRegistryFile ( const CRegistryFile )
private

forbidden

Member Function Documentation

bool CRegistryFile::DeleteField ( const string key)
void CRegistryFile::FromConfigFile ( CNcbiIstream istr)
CConstRef< CUser_field > CRegistryFile::GetField ( const string key) const

Definition at line 476 of file reg_file.cpp.

References f(), kDecimalDot, m_Registry, and s_GetFieldAt().

Referenced by FromConfigFile(), and GetReadView().

CRegistryReadView CRegistryFile::GetReadView ( const string section) const
const CUser_object & CRegistryFile::GetRegistry ( ) const

Definition at line 530 of file reg_file.cpp.

References _ASSERT, and m_Registry.

Referenced by FromConfigFile(), and Write().

CRegistryWriteView CRegistryFile::GetWriteView ( const string section)
bool CRegistryFile::HasField ( const string key) const

Definition at line 465 of file reg_file.cpp.

References kDecimalDot, m_Registry, and s_GetFieldAt().

bool CRegistryFile::IsRegistry ( const objects::CUser_object &  uo)
static

Is this user object suitable to use as a gui-registry site?

Definition at line 549 of file reg_file.cpp.

References kConfigObjClass(), and kConfigObjType().

Referenced by SetRegistry().

CRef< objects::CUser_object > CRegistryFile::NewRegistryObject ( )
static

make a new user object suitable to use as a gui-registry site.

Definition at line 556 of file reg_file.cpp.

References kConfigObjClass(), kConfigObjType(), and CRef< C, Locker >::Reset().

Referenced by SetRegistry().

CRegistryFile& CRegistryFile::operator= ( const CRegistryFile )
private
void CRegistryFile::Read ( CNcbiIstream istr)

Definition at line 452 of file reg_file.cpp.

References MSerial_AsnText, and SetRegistry().

Referenced by CRegistryFile().

CRef< CUser_field > CRegistryFile::SetField ( const string key)
CRef< CUser_field > CRegistryFile::SetFieldToValue ( const string key)
CUser_object & CRegistryFile::SetRegistry ( )

Definition at line 510 of file reg_file.cpp.

References m_Registry, and NewRegistryObject().

Referenced by CRegistryFile(), FromConfigFile(), Read(), SetField(), and SetRegistry().

void CRegistryFile::SetRegistry ( const objects::CUser_object &  uo)

precondition: IsRegistry(uo) is true.

Definition at line 520 of file reg_file.cpp.

References _ASSERT, IsRegistry(), m_Registry, CRef< C, Locker >::Reset(), and SetRegistry().

void CRegistryFile::ToConfigFile ( CNcbiOstream istr) const

Definition at line 439 of file reg_file.cpp.

References m_Registry, s_ScanRecursive(), and IRegistry::Write().

void CRegistryFile::Write ( CNcbiOstream istr) const

Definition at line 457 of file reg_file.cpp.

References GetRegistry(), m_Registry, and MSerial_AsnText.

Referenced by CWndLayoutReg::Save(), and CGuiRegistry::Write().

Member Data Documentation

CRef<objects::CUser_object> CRegistryFile::m_Registry
private

Definition at line 81 of file reg_file.hpp.

Referenced by GetField(), GetRegistry(), HasField(), SetRegistry(), ToConfigFile(), and Write().


The documentation for this class was generated from the following files:
Modified on Fri Apr 20 12:43:11 2018 by modify_doxy.py rev. 546573