#include <SpectrumViewerEvents.h>

Inheritance diagram for DynExpModule::SpectrumViewer::SetSilentModeEvent:

Public Member Functions
	SetSilentModeEvent (bool Enable=false)

	SetSilentModeEvent (const SetSilentModeEvent &Other, DynExp::ItemIDType CommunicatorID)

virtual	~SetSilentModeEvent ()

Public Member Functions inherited from DynExp::InterModuleEvent< SetSilentModeEvent, bool >
	InterModuleEvent ()=default
	Constructs an inter-module event.

	InterModuleEvent (const InterModuleEventBase &Other, ItemIDType CommunicatorID)
	Copy-constrcuts an inter-module event setting the CommunicatorID.

virtual	~InterModuleEvent ()

virtual InterModuleEventPtrType	Clone (ItemIDType CommunicatorID) const override final
	Creates a deep copy of this inter-module instance.

virtual size_t	GetID () const noexcept override final
	Returns the unique ID of this event type.

virtual std::string	GetName () const override
	Returns the name of this event type.

Public Member Functions inherited from DynExp::InterModuleEventBase
	InterModuleEventBase ()
	Constructs an inter-module event.

	InterModuleEventBase (const InterModuleEventBase &Other, ItemIDType CommunicatorID)
	Copy-constrcuts an inter-module event setting the CommunicatorID.

virtual	~InterModuleEventBase ()=0

auto	GetCommunicatorID () const noexcept
	Getter for CommunicatorID.

Public Member Functions inherited from DynExp::EventBase
	EventBase ()=default

virtual	~EventBase ()=0

void	Invoke (ModuleInstance &Instance) const
	Invokes the event passing the receiving module's instance reference to it. Only to be called from `ModuleBase`.

Private Member Functions
virtual void	InvokeWithParamsChild (DynExp::ModuleInstance &Instance, EventListenersType::EventFunctionType EventFunc) const override

Private Attributes
const bool	Enable

Additional Inherited Members
Public Types inherited from DynExp::InterModuleEvent< SetSilentModeEvent, bool >
using	EventListenersType = TypedEventListeners< EventFuncArgs... >
	Type of the manager of event listeners, which relates event listeners (instances of `ModuleBase`) to their event functions. The event functions expect `EventFuncArgs` as further arguments.

Public Types inherited from DynExp::InterModuleEventBase
using	InterModuleEventPtrType = std::unique_ptr< InterModuleEventBase >
	Pointer type to store an inter-module event (`InterModuleEventBase`).

Static Public Member Functions inherited from DynExp::InterModuleEvent< SetSilentModeEvent, bool >
static auto	ID ()
	Getter for EventID.

static size_t	Publish (InterModuleEventLibrary &Library)
	Publishes this event type to the `InterModuleEventLibrary`. This function should not be called manually.

static InterModuleEventPtrType	Make ()
	Factory function for events of type `DerivedEvent`.

static void	Register (const ModuleBase &Listener, CallableT EventFunc, ItemIDType CommunicatorID=ItemIDNotSet)
	Registers/Subscribes module `Listener` to the event with the event function `EventFunc`. Indirectly calls ModuleBase::AddRegisteredEvent(). If a module-communicator combination has already been registered, this registration is updated.

static void	Deregister (const ModuleBase &Listener)
	Deregisters/unsubscribes module `Listener` from the event, regardless of the inter-module communicator instance used to register `Listener` to the event. Indirectly calls ModuleBase::RemoveRegisteredEvent().

static void	Deregister (const ModuleBase &Listener, ItemIDType CommunicatorID)
	Deregisters/unsubscribes module `Listener` from the event, removing a single registration for a particular module/inter-module communicator combination. Indirectly calls ModuleBase::RemoveRegisteredEvent().

Detailed Description

Definition at line 38 of file SpectrumViewerEvents.h.

Constructor & Destructor Documentation

◆ SetSilentModeEvent() [1/2]

DynExpModule::SpectrumViewer::SetSilentModeEvent::SetSilentModeEvent ( bool Enable = false )

inline

Definition at line 41 of file SpectrumViewerEvents.h.

◆ SetSilentModeEvent() [2/2]

DynExpModule::SpectrumViewer::SetSilentModeEvent::SetSilentModeEvent	(	const SetSilentModeEvent &	Other,
		DynExp::ItemIDType	CommunicatorID
	)

inline

Definition at line 42 of file SpectrumViewerEvents.h.

◆ ~SetSilentModeEvent()

virtual DynExpModule::SpectrumViewer::SetSilentModeEvent::~SetSilentModeEvent ( )

inlinevirtual

Definition at line 43 of file SpectrumViewerEvents.h.

Member Function Documentation

◆ InvokeWithParamsChild()

void DynExpModule::SpectrumViewer::SetSilentModeEvent::InvokeWithParamsChild	(	DynExp::ModuleInstance &	Instance,
		EventListenersType::EventFunctionType	EventFunc
	)		const

overrideprivatevirtual

Definition at line 18 of file SpectrumViewerEvents.cpp.

Member Data Documentation

◆ Enable

const bool DynExpModule::SpectrumViewer::SetSilentModeEvent::Enable

private

Definition at line 48 of file SpectrumViewerEvents.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members