Version: 9.12.0
TMemFunEvent< TObject, TRes > Class Template Reference

Template class for event which calls the function without arguments and returning result. More...

#include <SALOME_Event.h>

Inheritance diagram for TMemFunEvent< TObject, TRes >:
Inheritance graph

Public Types

typedef TRes TResult
 
typedef TResult(TObject::* TAction) ()
 

Public Member Functions

 TMemFunEvent (TObject *theObject, TAction theAction, TResult theResult=TResult())
 
virtual void Execute ()
 This method should be redefined in the successor classes to do real work. More...
 
- Public Member Functions inherited from SALOME_Event
 SALOME_Event ()
 Constructor. More...
 
virtual ~SALOME_Event ()
 Destructor. More...
 
void ExecutePostedEvent ()
 This method should be called by the main GUI thread in order to execute the code specific for this event and finally to inform the calling thread that the event has been processed waking it up with help of the semaphore . More...
 
void process ()
 Post the event and wait for its completion. process() should be called from a secondary thread only. More...
 

Public Attributes

TResult myResult
 

Private Attributes

TObject * myObject
 
TAction myAction
 

Additional Inherited Members

- Static Public Member Functions inherited from SALOME_Event
static bool IsSessionThread ()
 Check if the processing is in the main application thread. More...
 
- Protected Member Functions inherited from SALOME_Event
void processed ()
 Use this method to signal that this event has been processed. More...
 
- Static Protected Member Functions inherited from SALOME_Event
static void GetSessionThread ()
 Initialize event mechanism. More...
 

Detailed Description

template<class TObject, typename TRes>
class TMemFunEvent< TObject, TRes >

Template class for event which calls the function without arguments and returning result.

Member Typedef Documentation

◆ TAction

template<class TObject , typename TRes >
typedef TResult(TObject::* TMemFunEvent< TObject, TRes >::TAction) ()

◆ TResult

template<class TObject , typename TRes >
typedef TRes TMemFunEvent< TObject, TRes >::TResult

Constructor & Destructor Documentation

◆ TMemFunEvent()

template<class TObject , typename TRes >
TMemFunEvent< TObject, TRes >::TMemFunEvent ( TObject *  theObject,
TAction  theAction,
TResult  theResult = TResult() 
)
inline

Member Function Documentation

◆ Execute()

template<class TObject , typename TRes >
virtual void TMemFunEvent< TObject, TRes >::Execute ( )
inlinevirtual

This method should be redefined in the successor classes to do real work.

Implements SALOME_Event.

References TMemFunEvent< TObject, TRes >::myAction, TMemFunEvent< TObject, TRes >::myObject, and TMemFunEvent< TObject, TRes >::myResult.

Member Data Documentation

◆ myAction

template<class TObject , typename TRes >
TAction TMemFunEvent< TObject, TRes >::myAction
private

◆ myObject

template<class TObject , typename TRes >
TObject* TMemFunEvent< TObject, TRes >::myObject
private

◆ myResult

template<class TObject , typename TRes >
TResult TMemFunEvent< TObject, TRes >::myResult

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