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

Search Toolkit Book for CChangePhyloSelectionSetCmd

SelectionSets are stored in the biotreecontainer's user-data object so we need a special change command object to handle it's undo-and redo. More...

+ Inheritance diagram for CChangePhyloSelectionSetCmd:
+ Collaboration diagram for CChangePhyloSelectionSetCmd:

Public Member Functions

 CChangePhyloSelectionSetCmd (CPhyTreeView *view, CSelectionSetEdit *sel_edit, CRef< CPhyloTreeDataSource > ds, CConstRef< objects::CBioTreeContainer > bio_tree)
 
void PerformEdit ()
 
virtual void Execute ()
 Do the editing action. More...
 
virtual void Unexecute ()
 Undo (opposite to Execute()) More...
 
virtual string GetLabel ()
 
- 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 IEditCommand
virtual ~IEditCommand ()
 
virtual bool CanMerge (IEditCommand *)
 
virtual void Merge (IEditCommand *)
 
virtual ~IEditCommand ()
 
virtual void Do (IScopeTransaction_Impl &)=0
 
virtual void Undo ()=0
 

Private Attributes

CPhyTreeViewm_View
 
CConstRef< objects::CBioTreeContainer > m_BioTree
 
CRef< CPhyloTreeDataSourcem_DS
 
CRef< CSelectionSetEditm_SelectionEdit
 

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

SelectionSets are stored in the biotreecontainer's user-data object so we need a special change command object to handle it's undo-and redo.

CChangePhyloTreeCommand which saves the entire tree would also work, but is much less (space) efficient

Definition at line 232 of file phy_tree_view.cpp.

Constructor & Destructor Documentation

◆ CChangePhyloSelectionSetCmd()

CChangePhyloSelectionSetCmd::CChangePhyloSelectionSetCmd ( CPhyTreeView view,
CSelectionSetEdit sel_edit,
CRef< CPhyloTreeDataSource ds,
CConstRef< objects::CBioTreeContainer >  bio_tree 
)
inline

Definition at line 235 of file phy_tree_view.cpp.

References m_BioTree, m_DS, m_SelectionEdit, m_View, and CRef< C, Locker >::Reset().

Member Function Documentation

◆ Execute()

virtual void CChangePhyloSelectionSetCmd::Execute ( )
inlinevirtual

◆ GetLabel()

virtual string CChangePhyloSelectionSetCmd::GetLabel ( void  )
inlinevirtual

Implements IEditCommand.

Definition at line 290 of file phy_tree_view.cpp.

◆ PerformEdit()

void CChangePhyloSelectionSetCmd::PerformEdit ( )
inline

◆ Unexecute()

virtual void CChangePhyloSelectionSetCmd::Unexecute ( )
inlinevirtual

Member Data Documentation

◆ m_BioTree

CConstRef<objects::CBioTreeContainer> CChangePhyloSelectionSetCmd::m_BioTree
private

Definition at line 296 of file phy_tree_view.cpp.

Referenced by CChangePhyloSelectionSetCmd(), and PerformEdit().

◆ m_DS

CRef<CPhyloTreeDataSource> CChangePhyloSelectionSetCmd::m_DS
private

Definition at line 298 of file phy_tree_view.cpp.

Referenced by CChangePhyloSelectionSetCmd(), Execute(), PerformEdit(), and Unexecute().

◆ m_SelectionEdit

CRef<CSelectionSetEdit> CChangePhyloSelectionSetCmd::m_SelectionEdit
private

Definition at line 299 of file phy_tree_view.cpp.

Referenced by CChangePhyloSelectionSetCmd(), Execute(), and Unexecute().

◆ m_View

CPhyTreeView* CChangePhyloSelectionSetCmd::m_View
private

Definition at line 293 of file phy_tree_view.cpp.

Referenced by CChangePhyloSelectionSetCmd(), and PerformEdit().


The documentation for this class was generated from the following file:
Modified on Wed Sep 04 15:01:12 2024 by modify_doxy.py rev. 669887