Medical Imaging Interaction Toolkit  2018.04.99-3ec0dd08
Medical Imaging Interaction Toolkit
us::ModuleEventHook Struct Referenceabstract

#include <usModuleEventHook.h>

Public Member Functions

virtual ~ModuleEventHook ()
 
virtual void Event (const ModuleEvent &event, ShrinkableVector< ModuleContext *> &contexts)=0
 

Detailed Description

Module Event Hook Service.

Modules registering this service will be called during module lifecycle (loading, loaded, unloading, and unloaded) operations.

Remarks
Implementations of this interface are required to be thread-safe.

Definition at line 44 of file usModuleEventHook.h.

Constructor & Destructor Documentation

◆ ~ModuleEventHook()

virtual us::ModuleEventHook::~ModuleEventHook ( )
virtual

Member Function Documentation

◆ Event()

virtual void us::ModuleEventHook::Event ( const ModuleEvent event,
ShrinkableVector< ModuleContext *> &  contexts 
)
pure virtual

Module event hook method. This method is called prior to module event delivery when a module is loading, loaded, unloading, or unloaded. This method can filter the modules which receive the event.

This method is called one and only one time for each module event generated, this includes module events which are generated when there are no module listeners registered.

Parameters
eventThe module event to be delivered.
contextsA list of Module Contexts for modules which have listeners to which the specified event will be delivered. The implementation of this method may remove module contexts from the list to prevent the event from being delivered to the associated modules.

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