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

Search Toolkit Book for CApplyObject

#include <objtools/edit/apply_object.hpp>

+ Inheritance diagram for CApplyObject:
+ Collaboration diagram for CApplyObject:

Public Member Functions

 CApplyObject (CSeq_entry_Handle seh, CConstRef< CObject > orig, CRef< CObject > editable)
 
 CApplyObject (CBioseq_Handle bsh, const CSeqdesc &desc)
 
 CApplyObject (CBioseq_Handle bsh, CSeqdesc::E_Choice subtype)
 
 CApplyObject (CBioseq_Handle bsh, const string &user_label)
 
 CApplyObject (CBioseq_Handle bsh, const CSeq_feat &feat)
 
 CApplyObject (CBioseq_Handle bsh)
 
bool PreExists () const
 
CObjectSetObject ()
 
const CObjectGetObject () const
 
const CObjectGetOriginalObject () const
 
void ReplaceEditable (CObject &edit)
 
void DeleteEditable (bool do_delete=true)
 
CSeq_entry_Handle GetSEH () const
 
void ApplyChange ()
 
- 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 Attributes

CSeq_entry_Handle m_SEH
 
CConstRef< CObjectm_Original
 
CRef< CObjectm_Editable
 
bool m_Delete
 

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

Definition at line 50 of file apply_object.hpp.

Constructor & Destructor Documentation

◆ CApplyObject() [1/6]

CApplyObject::CApplyObject ( CSeq_entry_Handle  seh,
CConstRef< CObject orig,
CRef< CObject editable 
)
inline

Definition at line 53 of file apply_object.hpp.

◆ CApplyObject() [2/6]

CApplyObject::CApplyObject ( CBioseq_Handle  bsh,
const CSeqdesc desc 
)

◆ CApplyObject() [3/6]

CApplyObject::CApplyObject ( CBioseq_Handle  bsh,
CSeqdesc::E_Choice  subtype 
)

◆ CApplyObject() [4/6]

CApplyObject::CApplyObject ( CBioseq_Handle  bsh,
const string user_label 
)

◆ CApplyObject() [5/6]

CApplyObject::CApplyObject ( CBioseq_Handle  bsh,
const CSeq_feat feat 
)

◆ CApplyObject() [6/6]

CApplyObject::CApplyObject ( CBioseq_Handle  bsh)

Member Function Documentation

◆ ApplyChange()

void CApplyObject::ApplyChange ( )

◆ DeleteEditable()

void CApplyObject::DeleteEditable ( bool  do_delete = true)
inline

Definition at line 67 of file apply_object.hpp.

◆ GetObject()

const CObject& CApplyObject::GetObject ( void  ) const
inline

Definition at line 64 of file apply_object.hpp.

◆ GetOriginalObject()

const CObject* CApplyObject::GetOriginalObject ( ) const
inline

Definition at line 65 of file apply_object.hpp.

Referenced by GetCommandFromApplyObject().

◆ GetSEH()

CSeq_entry_Handle CApplyObject::GetSEH ( ) const
inline

Definition at line 68 of file apply_object.hpp.

Referenced by GetCommandFromApplyObject().

◆ PreExists()

bool CApplyObject::PreExists ( ) const
inline

Definition at line 62 of file apply_object.hpp.

Referenced by GetCommandFromApplyObject().

◆ ReplaceEditable()

void CApplyObject::ReplaceEditable ( CObject edit)
inline

Definition at line 66 of file apply_object.hpp.

◆ SetObject()

CObject& CApplyObject::SetObject ( void  )
inline

Definition at line 63 of file apply_object.hpp.

Referenced by GetCommandFromApplyObject().

Member Data Documentation

◆ m_Delete

bool CApplyObject::m_Delete
protected

Definition at line 75 of file apply_object.hpp.

Referenced by ApplyChange().

◆ m_Editable

CRef<CObject> CApplyObject::m_Editable
protected

Definition at line 74 of file apply_object.hpp.

Referenced by ApplyChange(), and CApplyObject().

◆ m_Original

CConstRef<CObject> CApplyObject::m_Original
protected

Definition at line 73 of file apply_object.hpp.

Referenced by ApplyChange(), and CApplyObject().

◆ m_SEH

CSeq_entry_Handle CApplyObject::m_SEH
protected

Definition at line 72 of file apply_object.hpp.

Referenced by ApplyChange(), and CApplyObject().


The documentation for this class was generated from the following files:
Modified on Thu Jul 11 17:59:16 2024 by modify_doxy.py rev. 669887