MxEndActionNotificationParam Class Reference

[AI] Notification parameter marking the end of an action, specialization of MxActionNotificationParam. More...

#include <mxactionnotificationparam.h>

Inheritance diagram for MxEndActionNotificationParam:

Collaboration diagram for MxEndActionNotificationParam:

Public Member Functions
	MxEndActionNotificationParam (NotificationId p_type, MxCore *p_sender, MxDSAction *p_action, MxBool p_reallocAction)
	[AI] Constructs an end-action notification param. More...
MxNotificationParam *	Clone () const override
	[AI] Returns a clone of this notification parameter, specializing the type for end-action. [AI] More...
Public Member Functions inherited from MxActionNotificationParam
	MxActionNotificationParam (NotificationId p_type, MxCore *p_sender, MxDSAction *p_action, MxBool p_reallocAction)
	[AI] Constructs the action notification parameter, optionally cloning the action if requested. More...
	~MxActionNotificationParam () override
	[AI] Destructor releases the action if this object owns it (realloc flag set). [AI] More...
MxNotificationParam *	Clone () const override
	[AI] Creates a clone of this notification parameter with the same state. More...
MxDSAction *	GetAction ()
	[AI] Direct access to the underlying action. More...
Public Member Functions inherited from MxNotificationParam
	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...

Additional Inherited Members
Protected Attributes inherited from MxActionNotificationParam
MxDSAction *	m_action
	[AI] Associated action (owned if m_realloc is true). [AI] More...
MxBool	m_realloc
	[AI] TRUE if this object owns and should free m_action. [AI] More...
Protected Attributes inherited from MxNotificationParam
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] Notification parameter marking the end of an action, specialization of MxActionNotificationParam.

[AI]

Definition at line 97 of file mxactionnotificationparam.h.

Constructor & Destructor Documentation

MxEndActionNotificationParam()

MxEndActionNotificationParam::MxEndActionNotificationParam ( NotificationId  p_type, MxCore *  p_sender, MxDSAction *  p_action, MxBool  p_reallocAction  )

inline

[AI] Constructs an end-action notification param.

[AI]

Parameters

p_type	Notification type for action end events. [AI]
p_sender	Notification sender object. [AI]
p_action	Associated action. [AI]
p_reallocAction	Whether to clone the action. [AI]

Definition at line 104 of file mxactionnotificationparam.h.

Member Function Documentation

Clone()

MxNotificationParam * MxEndActionNotificationParam::Clone ( ) const

inlineoverridevirtual

[AI] Returns a clone of this notification parameter, specializing the type for end-action. [AI]

Reimplemented from MxActionNotificationParam.

Definition at line 110 of file mxactionnotificationparam.h.

---

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

• mxactionnotificationparam.h