Dali 3D User Interface Engine
List of all members | Public Types | Public Member Functions | Private Attributes
Dali::Internal::MessageValue3< T, P1, P2, P3 > Class Template Reference

Templated message which calls a member function of an object. More...

#include <message.h>

Inheritance diagram for Dali::Internal::MessageValue3< T, P1, P2, P3 >:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::MessageValue3< T, P1, P2, P3 >:
Collaboration graph
[legend]

Public Types

typedef void(T::* MemberFunction )(typename ParameterType< P1 >::PassingType, typename ParameterType< P2 >::PassingType, typename ParameterType< P3 >::PassingType)
 

Public Member Functions

 MessageValue3 (const T *obj, MemberFunction member, typename ParameterType< P1 >::PassingType p1, typename ParameterType< P2 >::PassingType p2, typename ParameterType< P3 >::PassingType p3)
 Create a message. More...
 
virtual ~MessageValue3 ()
 Virtual destructor. More...
 
virtual void Process (BufferIndex)
 Called to process the message. More...
 
- Public Member Functions inherited from Dali::Internal::MessageBase
 MessageBase ()
 Construct the message base. More...
 
virtual ~MessageBase ()
 Virtual destructor. More...
 

Private Attributes

T * object
 
MemberFunction memberFunction
 
ParameterType< P1 >::HolderType param1
 
ParameterType< P2 >::HolderType param2
 
ParameterType< P3 >::HolderType param3
 

Detailed Description

template<typename T, typename P1, typename P2, typename P3>
class Dali::Internal::MessageValue3< T, P1, P2, P3 >

Templated message which calls a member function of an object.

This overload passes three value-type parameters. Template parameters need to match the MemberFunction! The message will contain copy of the value (in case of & or const&)

Definition at line 239 of file message.h.

Member Typedef Documentation

template<typename T , typename P1 , typename P2 , typename P3 >
typedef void(T::* Dali::Internal::MessageValue3< T, P1, P2, P3 >::MemberFunction)(typename ParameterType< P1 >::PassingType, typename ParameterType< P2 >::PassingType, typename ParameterType< P3 >::PassingType)

Definition at line 243 of file message.h.

Constructor & Destructor Documentation

template<typename T , typename P1 , typename P2 , typename P3 >
Dali::Internal::MessageValue3< T, P1, P2, P3 >::MessageValue3 ( const T *  obj,
MemberFunction  member,
typename ParameterType< P1 >::PassingType  p1,
typename ParameterType< P2 >::PassingType  p2,
typename ParameterType< P3 >::PassingType  p3 
)
inline

Create a message.

Note
The object is expected to be const in the thread which sends this message. However it can be modified when Process() is called in a different thread.
Parameters
[in]objThe object.
[in]memberThe member function of the object.
[in]p1The first parameter to pass to the member function.
[in]p2The second parameter to pass to the member function.
[in]p3The third parameter to pass to the member function.

Definition at line 258 of file message.h.

template<typename T , typename P1 , typename P2 , typename P3 >
virtual Dali::Internal::MessageValue3< T, P1, P2, P3 >::~MessageValue3 ( )
inlinevirtual

Virtual destructor.

Definition at line 275 of file message.h.

Member Function Documentation

template<typename T , typename P1 , typename P2 , typename P3 >
virtual void Dali::Internal::MessageValue3< T, P1, P2, P3 >::Process ( BufferIndex  )
inlinevirtual

Called to process the message.

Parameters
[in]bufferIndexThe current update/render buffer index (depending on which thread processes the message).

Implements Dali::Internal::MessageBase.

Definition at line 282 of file message.h.

References DALI_ASSERT_DEBUG, Dali::Internal::MessageValue3< T, P1, P2, P3 >::memberFunction, Dali::Internal::MessageValue3< T, P1, P2, P3 >::param1, Dali::Internal::MessageValue3< T, P1, P2, P3 >::param2, Dali::Internal::MessageValue3< T, P1, P2, P3 >::param3, and Dali::Internal::ComplexType< T >::PassObject().

Here is the call graph for this function:

Member Data Documentation

template<typename T , typename P1 , typename P2 , typename P3 >
MemberFunction Dali::Internal::MessageValue3< T, P1, P2, P3 >::memberFunction
private

Definition at line 294 of file message.h.

Referenced by Dali::Internal::MessageValue3< T, P1, P2, P3 >::Process().

template<typename T , typename P1 , typename P2 , typename P3 >
T* Dali::Internal::MessageValue3< T, P1, P2, P3 >::object
private

Definition at line 293 of file message.h.

template<typename T , typename P1 , typename P2 , typename P3 >
ParameterType< P1 >::HolderType Dali::Internal::MessageValue3< T, P1, P2, P3 >::param1
private

Definition at line 295 of file message.h.

Referenced by Dali::Internal::MessageValue3< T, P1, P2, P3 >::Process().

template<typename T , typename P1 , typename P2 , typename P3 >
ParameterType< P2 >::HolderType Dali::Internal::MessageValue3< T, P1, P2, P3 >::param2
private

Definition at line 296 of file message.h.

Referenced by Dali::Internal::MessageValue3< T, P1, P2, P3 >::Process().

template<typename T , typename P1 , typename P2 , typename P3 >
ParameterType< P3 >::HolderType Dali::Internal::MessageValue3< T, P1, P2, P3 >::param3
private

Definition at line 297 of file message.h.

Referenced by Dali::Internal::MessageValue3< T, P1, P2, P3 >::Process().


The documentation for this class was generated from the following file:
Dali Docs Home
Read more about Dali