MeVisLab Toolbox Reference
ml::CSOCommand Class Referenceabstract

Base class for a CSOCommand for the undo/redo mechanism. More...

#include <CSOUndoRedoCommands.h>

Inheritance diagram for ml::CSOCommand:
ml::CSOCmdAddCSO ml::CSOCmdAddCSOGroup ml::CSOCmdAddCSOList ml::CSOCmdAddCSOSet ml::CSOCmdAddCSOtoGroup ml::CSOCmdCSOModifyVisualAttributes ml::CSOCmdInsertRemoveSeedPoint ml::CSOCmdModifySet ml::CSOCmdMoveContour ml::CSOCmdMoveSeedPoint ml::CSOCmdRemoveCSO ml::CSOCmdRemoveCSOGroup ml::CSOCmdRemoveCSOSet ml::CSOCmdRemoveCSOfromGroup

Public Member Functions

 CSOCommand (const CSOListPtr &csoList)
 Constructor.
 ~CSOCommand () override
 Destructor.
virtual int execute ()=0
void undo () override
 Calls execute.

Public Attributes

std::string commandName
 The command as a string (for debugging purposes).

Protected Member Functions

bool checkRedoBehavior () const override

Protected Attributes

CSOList * _csoList
 Pointer to the csoList.

Detailed Description

Base class for a CSOCommand for the undo/redo mechanism.

Definition at line 30 of file CSOUndoRedoCommands.h.

Constructor & Destructor Documentation

◆ CSOCommand()

ml::CSOCommand::CSOCommand ( const CSOListPtr & csoList)

Constructor.

◆ ~CSOCommand()

ml::CSOCommand::~CSOCommand ( )
override

Destructor.

Member Function Documentation

◆ checkRedoBehavior()

bool ml::CSOCommand::checkRedoBehavior ( ) const
inlineoverrideprotected

Returns whether the undo/redo behavior should be checked; returns 'false' to disable the check. Not every undo step generates a redo step (a previous step might generate two instead).

Definition at line 54 of file CSOUndoRedoCommands.h.

◆ execute()

virtual int ml::CSOCommand::execute ( )
pure virtual

Execute method that must be overridden by each derived class. Is called for undo/redo mechanism. Returns a notification flag.

Implemented in ml::CSOCmdAddCSO, ml::CSOCmdAddCSOGroup, ml::CSOCmdAddCSOList, ml::CSOCmdAddCSOSet, ml::CSOCmdAddCSOtoGroup, ml::CSOCmdCSOModifyVisualAttributes, ml::CSOCmdInsertRemoveSeedPoint, ml::CSOCmdModifySet, ml::CSOCmdMoveContour, ml::CSOCmdMoveSeedPoint, ml::CSOCmdRemoveCSO, ml::CSOCmdRemoveCSOfromGroup, ml::CSOCmdRemoveCSOGroup, and ml::CSOCmdRemoveCSOSet.

◆ undo()

void ml::CSOCommand::undo ( )
override

Calls execute.

Member Data Documentation

◆ _csoList

CSOList* ml::CSOCommand::_csoList
protected

Pointer to the csoList.

Definition at line 57 of file CSOUndoRedoCommands.h.

◆ commandName

std::string ml::CSOCommand::commandName

The command as a string (for debugging purposes).

Definition at line 48 of file CSOUndoRedoCommands.h.

The documentation for this class was generated from the following file: