OpenWalnut  1.5.0dev
Public Member Functions | Protected Attributes | List of all members
WModuleReadyEvent Class Reference

Event signalling a new module has been associated with the root container in the kernel. More...

#include <WModuleReadyEvent.h>

+ Inheritance diagram for WModuleReadyEvent:
+ Collaboration diagram for WModuleReadyEvent:

Public Member Functions

 WModuleReadyEvent (std::shared_ptr< WModule > module)
 Creates a new event instance denoting that the specified module got associated in the root container. More...
 
virtual ~WModuleReadyEvent ()
 Destructor. More...
 
std::shared_ptr< WModulegetModule ()
 Getter for the module that got associated. More...
 

Protected Attributes

std::shared_ptr< WModulem_module
 The module that got associated. More...
 

Detailed Description

Event signalling a new module has been associated with the root container in the kernel.

Please note that it is possible that the module is already marked as "ready" while processing this event due to the multithreading.

Definition at line 38 of file WModuleReadyEvent.h.

Constructor & Destructor Documentation

◆ WModuleReadyEvent()

WModuleReadyEvent::WModuleReadyEvent ( std::shared_ptr< WModule module)
explicit

Creates a new event instance denoting that the specified module got associated in the root container.

Parameters
modulethe module that switched its state.

Definition at line 30 of file WModuleReadyEvent.cpp.

◆ ~WModuleReadyEvent()

WModuleReadyEvent::~WModuleReadyEvent ( )
virtual

Destructor.

Definition at line 37 of file WModuleReadyEvent.cpp.

Member Function Documentation

◆ getModule()

std::shared_ptr< WModule > WModuleReadyEvent::getModule ( )

Getter for the module that got associated.

Returns
the module.

Definition at line 42 of file WModuleReadyEvent.cpp.

References m_module.

Referenced by WQtControlPanel::event(), WQtNetworkEditor::event(), and WMainWindow::event().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_module

std::shared_ptr< WModule > WModuleReadyEvent::m_module
protected

The module that got associated.

Definition at line 64 of file WModuleReadyEvent.h.

Referenced by getModule().


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