TMemFunEvent< TObject, TRes > Class Template Reference

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

#include <SALOME_Event.h>

Inheritance diagram for TMemFunEvent< TObject, TRes >:

Public Types
typedef TRes	TResult
typedef TResult(TObject::*	TAction )()
Public Member Functions
	TMemFunEvent (TObject *theObject, TAction theAction, TResult theResult=TResult())
virtual void	Execute ()
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 .
void	process ()
	Post the event and wait for its completion. process() should be called from a secondary thread only.
Static Public Member Functions
static bool	IsSessionThread ()
	Check if the processing is in the main application thread.
Data Fields
TResult	myResult
Protected Member Functions
void	processed ()
	Use this method to signal that this event has been processed.
Static Protected Member Functions
static void	GetSessionThread ()
	Initialize event mechanism.
Private Attributes
TObject *	myObject
TAction	myAction

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

---

Member Typedef Documentation

template<class TObject , typename TRes >

typedef TRes TMemFunEvent< TObject, TRes >.TResult

template<class TObject , typename TRes >

typedef TResult(TObject::* TMemFunEvent< TObject, TRes >.TAction)()

---

Constructor & Destructor Documentation

template<class TObject , typename TRes >

TMemFunEvent< TObject, TRes >.TMemFunEvent	(	TObject *	theObject,
		TAction	theAction,
		TResult	theResult = TResult()
	)

---

Member Function Documentation

template<class TObject , typename TRes >

virtual void TMemFunEvent< TObject, TRes >.Execute

(

)

[virtual]

Implements SALOME_Event.

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

void SALOME_Event::ExecutePostedEvent

(

)

[inherited]

References SALOME_Event.Execute(), SALOME_Event.IsSessionThread(), and SALOME_Event.processed().

bool SALOME_Event::IsSessionThread

(

)

[static, inherited]

Returns:

true if this method is called from the main application thread

References myThread.

void SALOME_Event::process

(

)

[inherited]

See also:

processed()

References SALOME_Event.IsSessionThread(), SALOME_Event.mySemaphore, and SALOME_EVENT.

void SALOME_Event::processed

(

)

[protected, inherited]

References SALOME_Event.mySemaphore.

void SALOME_Event::GetSessionThread

(

)

[static, protected, inherited]

This function sets up the main application thread. It should be called during the application initialization, i.e. main() function.

References myThread.

---

Field Documentation

template<class TObject , typename TRes >

TResult TMemFunEvent< TObject, TRes >.myResult

template<class TObject , typename TRes >

TObject* TMemFunEvent< TObject, TRes >.myObject [private]

template<class TObject , typename TRes >

TAction TMemFunEvent< TObject, TRes >.myAction [private]