Medical Imaging Interaction Toolkit  2021.02.99-89548602
Medical Imaging Interaction Toolkit
us::ModuleEvent Class Reference

#include <usModuleEvent.h>

Public Types

enum  Type { LOADED, UNLOADED, LOADING, UNLOADING }
 

Public Member Functions

 ModuleEvent ()
 
 ~ModuleEvent ()
 
bool IsNull () const
 
 ModuleEvent (Type type, Module *module)
 
 ModuleEvent (const ModuleEvent &other)
 
ModuleEventoperator= (const ModuleEvent &other)
 
ModuleGetModule () const
 
Type GetType () const
 

Detailed Description

An event from the Micro Services framework describing a module lifecycle change.

ModuleEvent objects are delivered to listeners connected via ModuleContext::AddModuleListener() when a change occurs in a modules's lifecycle. A type code is used to identify the event type for future extendability.

See also
ModuleContext::AddModuleListener

Definition at line 46 of file usModuleEvent.h.

Member Enumeration Documentation

◆ Type

Enumerator
LOADED 

The module has been loaded.

The module's ModuleActivator Load method has been executed.

UNLOADED 

The module has been unloaded.

The module's ModuleActivator Unload method has been executed.

LOADING 

The module is about to be loaded.

The module's ModuleActivator Load method is about to be called.

UNLOADING 

The module is about to be unloaded.

The module's ModuleActivator Unload method is about to be called.

Definition at line 53 of file usModuleEvent.h.

Constructor & Destructor Documentation

◆ ModuleEvent() [1/3]

us::ModuleEvent::ModuleEvent ( )

Creates an invalid instance.

◆ ~ModuleEvent()

us::ModuleEvent::~ModuleEvent ( )

◆ ModuleEvent() [2/3]

us::ModuleEvent::ModuleEvent ( Type  type,
Module module 
)

Creates a module event of the specified type.

Parameters
typeThe event type.
moduleThe module which had a lifecycle change.

◆ ModuleEvent() [3/3]

us::ModuleEvent::ModuleEvent ( const ModuleEvent other)

Member Function Documentation

◆ GetModule()

Module* us::ModuleEvent::GetModule ( ) const

Returns the module which had a lifecycle change.

Returns
The module that had a change occur in its lifecycle.

◆ GetType()

Type us::ModuleEvent::GetType ( ) const

Returns the type of lifecyle event. The type values are:

Returns
The type of lifecycle event.

◆ IsNull()

bool us::ModuleEvent::IsNull ( ) const

Can be used to check if this ModuleEvent instance is valid, or if it has been constructed using the default constructor.

Returns
true if this event object is valid, false otherwise.

◆ operator=()

ModuleEvent& us::ModuleEvent::operator= ( const ModuleEvent other)

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