MeVisLab Toolbox Reference
ml::BackgroundTaskMethodCallMessage< Object, Method, ArgumentList > Class Template Reference

A generic message that allows to call the member function method on a given object, passing the arguments args. More...

#include <mlBackgroundTaskMethodCallMessage.h>

Inheritance diagram for ml::BackgroundTaskMethodCallMessage< Object, Method, ArgumentList >:
ml::BackgroundTaskMessage

Public Member Functions

 BackgroundTaskMethodCallMessage (Object *object, Method method, const ArgumentList &args)
 
void execute () override
 Executes message when it is delivered.
 
- Public Member Functions inherited from ml::BackgroundTaskMessage
 BackgroundTaskMessage ()
 
virtual ~BackgroundTaskMessage ()
 
void setSender (BackgroundTask *task)
 Sets who sends the message. Default is NULL and this means that the message's sender is not a BackgroundTask.
 
BackgroundTasksender ()
 Returns the task from which the message originates.
 
void setReceiver (BackgroundTaskMessageReceiver *receiverArg)
 Sets who receives the message. Default is NULL.
 
BackgroundTaskMessageReceiverreceiver ()
 Returns the object which receives the message. Default is NULL.
 
virtual void executeSynchronous ()
 Executes message when it is delivered and the task runs synchronously.
 
virtual bool finishedProcessing ()
 Returns whether the message needs further processing or if it may be deleted.
 
virtual void taskWillBeDestroyed ()
 This needs to be implemented if the message uses finishedProcessing() and the task is finished while a message is still on its way.
 

Detailed Description

template<class Object, class Method, class ArgumentList>
class ml::BackgroundTaskMethodCallMessage< Object, Method, ArgumentList >

A generic message that allows to call the member function method on a given object, passing the arguments args.

ArgumentList is copied using the copy constructor of each argument.

Definition at line 27 of file mlBackgroundTaskMethodCallMessage.h.

Constructor & Destructor Documentation

◆ BackgroundTaskMethodCallMessage()

ml::BackgroundTaskMethodCallMessage< Object, Method, ArgumentList >::BackgroundTaskMethodCallMessage ( Object * object,
Method method,
const ArgumentList & args )
inline

Definition at line 29 of file mlBackgroundTaskMethodCallMessage.h.

Member Function Documentation

◆ execute()

Executes message when it is delivered.

Reimplement this in subclasses.

Implements ml::BackgroundTaskMessage.

Definition at line 35 of file mlBackgroundTaskMethodCallMessage.h.

References ml::MLCallMethodWithArguments().


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