DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpModule::StartEvent Class Reference

This event is intended to make the receiver either directly start an action (like a measurement) or to prepare the receiver to await a trigger event (TriggerEvent) which starts the action. More...

+ Inheritance diagram for DynExpModule::StartEvent:

Public Member Functions

 StartEvent ()=default
 
virtual ~StartEvent ()
 
- Public Member Functions inherited from DynExp::InterModuleEvent< StartEvent >
 InterModuleEvent ()=default
 
virtual ~InterModuleEvent ()
 
- Public Member Functions inherited from DynExp::InterModuleEventBase
 InterModuleEventBase ()=default
 
virtual ~InterModuleEventBase ()=0
 
- 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. More...
 

Private Member Functions

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

Additional Inherited Members

- Public Types inherited from DynExp::InterModuleEvent< StartEvent >
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. More...
 
- Static Public Member Functions inherited from DynExp::InterModuleEvent< StartEvent >
static void Register (const ModuleBase &Listener, CallableT EventFunc)
 Registers/Subscribes module Listener to the event with the event function EventFunc. Indirectly calls ModuleBase::AddRegisteredEvent(). More...
 
static void Deregister (const ModuleBase &Listener)
 Deregisters/unsubscribes module Listener from the event. Indirectly calls ModuleBase::RemoveRegisteredEvent(). More...
 

Detailed Description

This event is intended to make the receiver either directly start an action (like a measurement) or to prepare the receiver to await a trigger event (TriggerEvent) which starts the action.

Definition at line 21 of file CommonModuleEvents.h.

Constructor & Destructor Documentation

◆ StartEvent()

DynExpModule::StartEvent::StartEvent ( )
default

◆ ~StartEvent()

virtual DynExpModule::StartEvent::~StartEvent ( )
inlinevirtual

Definition at line 25 of file CommonModuleEvents.h.

Member Function Documentation

◆ InvokeWithParamsChild()

void DynExpModule::StartEvent::InvokeWithParamsChild ( DynExp::ModuleInstance Instance,
EventListenersType::EventFunctionType  EventFunc 
) const
overrideprivatevirtual

Definition at line 8 of file CommonModuleEvents.cpp.


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