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

Search Toolkit Book for CScopeTransaction_Impl

#include <objmgr/impl/scope_transaction_impl.hpp>

+ Inheritance diagram for CScopeTransaction_Impl:
+ Collaboration diagram for CScopeTransaction_Impl:

Public Types

typedef CRef< IEditCommandTCommand
 
typedef list< TCommandTCommands
 
typedef CRef< CScope_ImplTScope
 
typedef set< TScopeTScopes
 
typedef set< IEditSaver * > TEditSavers
 
- Public Types inherited from IScopeTransaction_Impl
typedef CRef< IEditCommandTCommand
 
- 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

 CScopeTransaction_Impl (CScope_Impl &scope, IScopeTransaction_Impl *parent)
 
virtual ~CScopeTransaction_Impl ()
 
virtual void AddCommand (TCommand cmd)
 
virtual void AddEditSaver (IEditSaver *)
 
virtual void Commit ()
 
virtual void RollBack ()
 
virtual void AddScope (CScope_Impl &scope)
 
virtual bool HasScope (CScope_Impl &scope) const
 
- Public Member Functions inherited from IScopeTransaction_Impl
virtual ~IScopeTransaction_Impl ()
 
- 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
 

Protected Member Functions

virtual bool x_CanCommitRollBack () const
 
void x_AddScope (CScope_Impl &scope)
 
void x_DoFinish (IScopeTransaction_Impl *)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

TCommands m_Commands
 
TCommands::iterator m_CurCmd
 
TScopes m_Scopes
 
TEditSavers m_Savers
 
CRef< IScopeTransaction_Implm_Parent
 

Private Member Functions

 CScopeTransaction_Impl (const CScopeTransaction_Impl &)
 
CScopeTransaction_Imploperator= (const CScopeTransaction_Impl &)
 

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

Definition at line 116 of file scope_transaction_impl.hpp.

Member Typedef Documentation

◆ TCommand

Definition at line 120 of file scope_transaction_impl.hpp.

◆ TCommands

Definition at line 121 of file scope_transaction_impl.hpp.

◆ TEditSavers

Definition at line 124 of file scope_transaction_impl.hpp.

◆ TScope

Definition at line 122 of file scope_transaction_impl.hpp.

◆ TScopes

Definition at line 123 of file scope_transaction_impl.hpp.

Constructor & Destructor Documentation

◆ CScopeTransaction_Impl() [1/2]

CScopeTransaction_Impl::CScopeTransaction_Impl ( CScope_Impl scope,
IScopeTransaction_Impl parent 
)

Definition at line 87 of file scope_transaction_impl.cpp.

References m_Commands, m_CurCmd, and x_AddScope().

◆ ~CScopeTransaction_Impl()

CScopeTransaction_Impl::~CScopeTransaction_Impl ( )
virtual

Definition at line 95 of file scope_transaction_impl.cpp.

References ERR_POST_X, Fatal(), and RollBack().

◆ CScopeTransaction_Impl() [2/2]

CScopeTransaction_Impl::CScopeTransaction_Impl ( const CScopeTransaction_Impl )
private

Member Function Documentation

◆ AddCommand()

void CScopeTransaction_Impl::AddCommand ( TCommand  cmd)
virtual

Implements IScopeTransaction_Impl.

Definition at line 105 of file scope_transaction_impl.cpp.

References cmd, m_Commands, and m_CurCmd.

◆ AddEditSaver()

void CScopeTransaction_Impl::AddEditSaver ( IEditSaver saver)
virtual

◆ AddScope()

void CScopeTransaction_Impl::AddScope ( CScope_Impl scope)
virtual

Implements IScopeTransaction_Impl.

Definition at line 125 of file scope_transaction_impl.cpp.

References x_AddScope().

◆ Commit()

void CScopeTransaction_Impl::Commit ( void  )
virtual

◆ HasScope()

bool CScopeTransaction_Impl::HasScope ( CScope_Impl scope) const
virtual

◆ operator=()

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

◆ RollBack()

void CScopeTransaction_Impl::RollBack ( )
virtual

◆ x_AddScope()

void CScopeTransaction_Impl::x_AddScope ( CScope_Impl scope)
protected

◆ x_CanCommitRollBack()

bool CScopeTransaction_Impl::x_CanCommitRollBack ( ) const
protectedvirtual

Implements IScopeTransaction_Impl.

Definition at line 144 of file scope_transaction_impl.cpp.

References CScope_Impl::GetTransaction(), ITERATE, and m_Scopes.

Referenced by Commit(), and RollBack().

◆ x_DoFinish()

void CScopeTransaction_Impl::x_DoFinish ( IScopeTransaction_Impl parent)
protected

Member Data Documentation

◆ m_Commands

TCommands CScopeTransaction_Impl::m_Commands
protected

◆ m_CurCmd

TCommands::iterator CScopeTransaction_Impl::m_CurCmd
protected

◆ m_Parent

CRef<IScopeTransaction_Impl> CScopeTransaction_Impl::m_Parent
protected

Definition at line 148 of file scope_transaction_impl.hpp.

Referenced by AddEditSaver(), Commit(), HasScope(), RollBack(), and x_AddScope().

◆ m_Savers

TEditSavers CScopeTransaction_Impl::m_Savers
protected

Definition at line 147 of file scope_transaction_impl.hpp.

Referenced by AddEditSaver(), Commit(), RollBack(), and x_DoFinish().

◆ m_Scopes

TScopes CScopeTransaction_Impl::m_Scopes
protected

Definition at line 146 of file scope_transaction_impl.hpp.

Referenced by HasScope(), x_AddScope(), x_CanCommitRollBack(), and x_DoFinish().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:21 2024 by modify_doxy.py rev. 669887