MxNotificationParam Class Reference

[AI] Parameter object representing a single notification or event, carrying an identifier and sender pointer. More...

#include <mxnotificationparam.h>

Inheritance diagram for MxNotificationParam:

Collaboration diagram for MxNotificationParam:

Public Member Functions
	MxNotificationParam ()
	[AI] Constructs a default notification parameter with type c_notificationType0 and no sender. More...
	MxNotificationParam (NotificationId p_type, MxCore *p_sender)
	[AI] Constructs a notification parameter with a specific type and sender. More...
virtual MxNotificationParam *	Clone () const
	[AI] Creates a copy of this notification parameter object on the heap. More...
NotificationId	GetNotification () const
	[AI] Retrieves the current notification type of this parameter. More...
MxCore *	GetSender () const
	[AI] Retrieves the sender pointer associated with this notification. More...
void	SetNotification (NotificationId p_type)
	[AI] Sets the notification type for this parameter object. More...
void	SetSender (MxCore *p_sender)
	[AI] Sets the sender pointer for this notification parameter. More...
Public Member Functions inherited from MxParam
virtual	~MxParam ()
	[AI] Virtual destructor for safe polymorphic deletion of derived parameter objects. More...

Protected Attributes
NotificationId	m_type
	[AI] Type of notification/event carried by this object (see NotificationId). More...
MxCore *	m_sender
	[AI] Pointer to the MxCore instance that sent or originated this notification. More...

Detailed Description

[AI] Parameter object representing a single notification or event, carrying an identifier and sender pointer.

[AI] Used throughout the notification system to pass event information (such as event type and source) to subscribers/handlers. Typically delivered to components via MxOmni or similar dispatcher.

See also

NotificationId

Note

[AI] Inherits from MxParam. This enables it to be handled by notification/message passing infrastructure shared by other param types. @size 0x0c [AI]

Definition at line 47 of file mxnotificationparam.h.

Constructor & Destructor Documentation

MxNotificationParam() [1/2]

MxNotificationParam::MxNotificationParam ( )

inline

[AI] Constructs a default notification parameter with type c_notificationType0 and no sender.

Definition at line 50 of file mxnotificationparam.h.

MxNotificationParam() [2/2]

MxNotificationParam::MxNotificationParam ( NotificationId  p_type, MxCore *  p_sender  )

inline

[AI] Constructs a notification parameter with a specific type and sender.

Parameters

p_type	[AI] The notification/event identifier (see NotificationId).
p_sender	[AI] The MxCore instance that is the source of this notification.

Definition at line 55 of file mxnotificationparam.h.

Member Function Documentation

Clone()

virtual MxNotificationParam * MxNotificationParam::Clone ( ) const

inlinevirtual

[AI] Creates a copy of this notification parameter object on the heap.

[AI] Used by the messaging infrastructure to duplicate the notification when dispatching to multiple receivers.

Returns

[AI] Pointer to a cloned MxNotificationParam of the same type and sender.

Reimplemented in LegoEndAnimNotificationParam, LegoEventNotificationParam, LegoPathStructNotificationParam, MxActionNotificationParam, MxStartActionNotificationParam, MxEndActionNotificationParam, MxType4NotificationParam, and MxStreamerNotification.

Definition at line 60 of file mxnotificationparam.h.

GetNotification()

NotificationId MxNotificationParam::GetNotification ( ) const

inline

[AI] Retrieves the current notification type of this parameter.

Returns

[AI] NotificationId enumeration specifying the type of this notification.

Definition at line 64 of file mxnotificationparam.h.

GetSender()

MxCore * MxNotificationParam::GetSender ( ) const

inline

[AI] Retrieves the sender pointer associated with this notification.

Returns

[AI] A pointer to the MxCore object that originated this notification.

Definition at line 68 of file mxnotificationparam.h.

SetNotification()

void MxNotificationParam::SetNotification ( NotificationId  p_type )

inline

[AI] Sets the notification type for this parameter object.

Parameters

p_type

[AI] The new notification/event type identifier.

Definition at line 72 of file mxnotificationparam.h.

SetSender()

void MxNotificationParam::SetSender ( MxCore *  p_sender )

inline

[AI] Sets the sender pointer for this notification parameter.

Parameters

p_sender

[AI] Pointer to the MxCore that will be considered as sender/originator.

Definition at line 76 of file mxnotificationparam.h.

Member Data Documentation

m_sender

MxCore* MxNotificationParam::m_sender

protected

[AI] Pointer to the MxCore instance that sent or originated this notification.

Definition at line 80 of file mxnotificationparam.h.

m_type

NotificationId MxNotificationParam::m_type

protected

[AI] Type of notification/event carried by this object (see NotificationId).

Definition at line 79 of file mxnotificationparam.h.

---

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

• mxnotificationparam.h