ufe 5.5
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Public Types | Public Member Functions | List of all members
Ufe::CodeWrapper Class Referenceabstract

Wrap the execution of some other function, called sub-operation, with arbitrary prelude and cleanup virtual functions. More...

#include <codeWrapper.h>

Public Types

using Ptr = std::shared_ptr< CodeWrapper >
 

Public Member Functions

virtual ~CodeWrapper ()
 
virtual void prelude (const std::string &subOperation)=0
 Function called before execution of some other code. More...
 
virtual void cleanup (const std::string &subOperation)=0
 Function called after execution of some other code. More...
 

Detailed Description

Wrap the execution of some other function, called sub-operation, with arbitrary prelude and cleanup virtual functions.

For example, it can be used to surround the execute, undo and redo sub-operations of a command.

Definition at line 28 of file codeWrapper.h.

Member Typedef Documentation

◆ Ptr

using Ufe::CodeWrapper::Ptr = std::shared_ptr<CodeWrapper>

Definition at line 31 of file codeWrapper.h.

Constructor & Destructor Documentation

◆ ~CodeWrapper()

virtual Ufe::CodeWrapper::~CodeWrapper ( )
virtual

Member Function Documentation

◆ cleanup()

virtual void Ufe::CodeWrapper::cleanup ( const std::string &  subOperation)
pure virtual

Function called after execution of some other code.

Parameters
subOperationthe name of the sub-operation being wrapped.

◆ prelude()

virtual void Ufe::CodeWrapper::prelude ( const std::string &  subOperation)
pure virtual

Function called before execution of some other code.

Parameters
subOperationthe name of the sub-operation being wrapped.
The documentation for this class was generated from the following file: