NCBI C++ ToolKit
Public Types | Public Member Functions | Private Attributes | List of all members
CRemove_EditCommand< TEditHandle > Class Template Reference

Search Toolkit Book for CRemove_EditCommand

#include <objmgr/impl/edit_commands_impl.hpp>

+ Inheritance diagram for CRemove_EditCommand< TEditHandle >:
+ Collaboration diagram for CRemove_EditCommand< TEditHandle >:

Public Types

typedef RemoveAction< TEditHandle > TAction
 
- 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

 CRemove_EditCommand (const TEditHandle &handle, CScope_Impl &scope)
 
virtual ~CRemove_EditCommand ()
 
virtual void Do (IScopeTransaction_Impl &tr)
 
virtual void Undo ()
 
- Public Member Functions inherited from IEditCommand
virtual ~IEditCommand ()
 
virtual void Execute ()=0
 Do the editing action. More...
 
virtual void Unexecute ()=0
 Undo (opposite to Execute()) More...
 
virtual string GetLabel ()=0
 
virtual bool CanMerge (IEditCommand *)
 
virtual void Merge (IEditCommand *)
 
virtual ~IEditCommand ()
 
- 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
 

Private Attributes

CSeq_entry_EditHandle m_Entry
 
TEditHandle m_Handle
 
CScope_Implm_Scope
 

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

template<typename TEditHandle>
class CRemove_EditCommand< TEditHandle >

Definition at line 501 of file edit_commands_impl.hpp.

Member Typedef Documentation

◆ TAction

template<typename TEditHandle >
typedef RemoveAction<TEditHandle> CRemove_EditCommand< TEditHandle >::TAction

Definition at line 504 of file edit_commands_impl.hpp.

Constructor & Destructor Documentation

◆ CRemove_EditCommand()

template<typename TEditHandle >
CRemove_EditCommand< TEditHandle >::CRemove_EditCommand ( const TEditHandle &  handle,
CScope_Impl scope 
)
inline

Definition at line 506 of file edit_commands_impl.hpp.

◆ ~CRemove_EditCommand()

template<typename TEditHandle >
virtual CRemove_EditCommand< TEditHandle >::~CRemove_EditCommand ( )
inlinevirtual

Definition at line 511 of file edit_commands_impl.hpp.

Member Function Documentation

◆ Do()

template<typename TEditHandle >
virtual void CRemove_EditCommand< TEditHandle >::Do ( IScopeTransaction_Impl tr)
inlinevirtual

◆ Undo()

template<typename TEditHandle >
virtual void CRemove_EditCommand< TEditHandle >::Undo ( )
inlinevirtual

Member Data Documentation

◆ m_Entry

template<typename TEditHandle >
CSeq_entry_EditHandle CRemove_EditCommand< TEditHandle >::m_Entry
private

◆ m_Handle

template<typename TEditHandle >
TEditHandle CRemove_EditCommand< TEditHandle >::m_Handle
private

◆ m_Scope

template<typename TEditHandle >
CScope_Impl& CRemove_EditCommand< TEditHandle >::m_Scope
private

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