Streamer notification param for streaming events in MxStreamer [AI]. More...

#include <mxstreamer.h>

Inheritance diagram for MxStreamerNotification:

Collaboration diagram for MxStreamerNotification:

[legend]

Public Member Functions
	MxStreamerNotification (NotificationId p_type, MxCore p_sender, MxStreamController p_ctrlr)
	[AI] Create a streamer notification with a controller reference. More...

MxNotificationParam *	Clone () const override
	[AI] Clone this notification param. More...

MxStreamController *	GetController ()
	[AI] Retrieve the stream controller associated with this notification. 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 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

Streamer notification param for streaming events in MxStreamer [AI].

Extends MxNotificationParam by providing a reference to the affected MxStreamController for notification message passing when streaming operations change. [AI]

See also: MxNotificationParam [AI]

Definition at line 27 of file mxstreamer.h.

Constructor & Destructor Documentation

◆ MxStreamerNotification()

MxStreamerNotification::MxStreamerNotification	(	NotificationId	p_type,
		MxCore *	p_sender,
		MxStreamController *	p_ctrlr
	)

inline

[AI] Create a streamer notification with a controller reference.

Parameters

p_type	Type of notification [AI]
p_sender	Sender object [AI]
p_ctrlr	Affected stream controller pointer [AI]

Definition at line 35 of file mxstreamer.h.

Member Function Documentation

◆ Clone()

MxNotificationParam * MxStreamerNotification::Clone ( ) const

overridevirtual

[AI] Clone this notification param.

Used for notification delivery/copying.

Returns: Pointer to a new clone of the notification parameter [AI]

Reimplemented from MxNotificationParam.

Definition at line 125 of file mxstreamer.cpp.

◆ GetController()

MxStreamController * MxStreamerNotification::GetController ( )

inline

[AI] Retrieve the stream controller associated with this notification.

Returns: The stream controller affected by the notification [AI]

Definition at line 51 of file mxstreamer.h.

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