This event tells the receiver where to store e.g. acquired data. More...

#include <CommonModuleEvents.h>

Inheritance diagram for DynExpModule::SetFilenameEvent:

Public Member Functions
	SetFilenameEvent (const std::string &Filename="unknown")
	Constructs a `SetFilenameEvent` event.

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

virtual	~SetFilenameEvent ()

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

Public Member Functions inherited from DynExp::InterModuleEvent< SetFilenameEvent, std::string >
	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.

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
	Called by `InvokeChild()`. Override to call `EventFunc` with `Instance` as the first argument and with further arguments of type `EventFuncArgs`.

Private Attributes
const std::string	Filename
	Filename where to store data (path and name, no file extension). The receiving module is responsible for adding the required file extension.

Additional Inherited Members
Public Types inherited from DynExp::InterModuleEvent< SetFilenameEvent, std::string >
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< SetFilenameEvent, std::string >
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

This event tells the receiver where to store e.g. acquired data.

Definition at line 48 of file CommonModuleEvents.h.

Constructor & Destructor Documentation

◆ SetFilenameEvent() [1/2]

DynExpModule::SetFilenameEvent::SetFilenameEvent ( const std::string & Filename = "unknown" )

inline

Constructs a SetFilenameEvent event.

Parameters

Filename Filename where to store data (path and name, no file extension). The receiving module is responsible for adding the required file extension.

Definition at line 55 of file CommonModuleEvents.h.

◆ SetFilenameEvent() [2/2]

DynExpModule::SetFilenameEvent::SetFilenameEvent	(	const SetFilenameEvent &	Other,
		DynExp::ItemIDType	CommunicatorID
	)

inline

Definition at line 60 of file CommonModuleEvents.h.

◆ ~SetFilenameEvent()

virtual DynExpModule::SetFilenameEvent::~SetFilenameEvent ( )

inlinevirtual

Definition at line 63 of file CommonModuleEvents.h.

Member Function Documentation

◆ GetName()

virtual std::string DynExpModule::SetFilenameEvent::GetName ( ) const

inlineoverridevirtual

Returns the name of this event type.

Reimplemented from DynExp::InterModuleEvent< SetFilenameEvent, std::string >.

Definition at line 65 of file CommonModuleEvents.h.

◆ InvokeWithParamsChild()

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

overrideprivatevirtual

Called by InvokeChild(). Override to call EventFunc with Instance as the first argument and with further arguments of type EventFuncArgs.

Parameters

Instance	Handle to the module thread's data of the module `EventFunc` is invoked on.
EventFunc	Event function to invoke.

Definition at line 13 of file CommonModuleEvents.cpp.

Member Data Documentation

◆ Filename

const std::string DynExpModule::SetFilenameEvent::Filename

private

Filename where to store data (path and name, no file extension). The receiving module is responsible for adding the required file extension.

Definition at line 77 of file CommonModuleEvents.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members