OpenWalnut 1.3.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes
WKernel Class Reference

OpenWalnut kernel, managing modules and interaction between GUI, GE and DataHandler. More...

#include <WKernel.h>

Inheritance diagram for WKernel:

List of all members.

Public Member Functions

virtual ~WKernel ()
 Destructor.
void finalize ()
 Stops execution of the modules in the root container.
boost::shared_ptr
< WGraphicsEngine
getGraphicsEngine () const
 Returns pointer to currently running instance of graphics engine.
const WBoolFlagisFinishRequested () const
 Determines whether all threads should finish.
WBatchLoader::SPtr loadDataSets (std::vector< std::string > filenames, bool suppressColormaps=false)
 Load specified datasets.
WBatchLoader::SPtr loadDataSetsSynchronously (std::vector< std::string > filenames, bool suppressColormaps=false)
 Loads the specified files synchronously.
boost::shared_ptr< WModuleapplyModule (boost::shared_ptr< WModule > applyOn, boost::shared_ptr< WModule > prototype)
 Function combines to modules.
boost::shared_ptr
< WModuleContainer
getRootContainer () const
 Returns the root module container.
boost::shared_ptr< WGUIgetGui () const
 Getter for the associated GUI.
boost::shared_ptr< WROIManagergetRoiManager ()
 get for roi manager
boost::shared_ptr
< WSelectionManager
getSelectionManager ()
 get for selection manager
WTimer::ConstSPtr getTimer () const
 Returns the system timer.

Static Public Member Functions

static WKernelinstance (boost::shared_ptr< WGraphicsEngine > ge, boost::shared_ptr< WGUI > gui)
 Returns pointer to the running kernel or a new if no kernel was there.
static WKernelgetRunningKernel ()
 Returns pointer to the currently running kernel.

Protected Member Functions

 WKernel (boost::shared_ptr< WGraphicsEngine > ge, boost::shared_ptr< WGUI > gui)
 Constructor is protected because this class is a singleton.
virtual void threadMain ()
 Function that has to be overwritten for execution.

Protected Attributes

boost::shared_ptr< WGUIm_gui
 The Gui.
boost::shared_ptr
< WGraphicsEngine
m_graphicsEngine
 Pointer to an initialized graphics engine.
boost::shared_ptr< WROIManagerm_roiManager
 Pointer to a roi manager.
boost::shared_ptr
< WSelectionManager
m_selectionManager
 pointer to a selection manager
boost::shared_ptr< WModuleFactorym_moduleFactory
 The module factory to use.
boost::shared_ptr
< WModuleContainer
m_moduleContainer
 The container containing the modules.

Private Member Functions

void loadModules ()
 Loads all the modules it can find.
void init ()
 Initializes the graphics engine, data handler and so on.

Private Attributes

WTimer::SPtr m_timer
 The ow system timer.

Static Private Attributes

static WKernelm_kernel = NULL
 Pointer to the unique instance of this singleton class.

Detailed Description

OpenWalnut kernel, managing modules and interaction between GUI, GE and DataHandler.

Definition at line 63 of file WKernel.h.


Constructor & Destructor Documentation

WKernel::~WKernel ( ) [virtual]

Destructor.

Definition at line 74 of file WKernel.cpp.

References WLogger::addLogMessage(), and WLogger::getLogger().

WKernel::WKernel ( boost::shared_ptr< WGraphicsEngine ge,
boost::shared_ptr< WGUI gui 
) [protected]

Constructor is protected because this class is a singleton.

Awaits an INITIALIZED graphics engine an gui.

Parameters:
geinitialized graphics engine.
guiinitialized gui.

Definition at line 54 of file WKernel.cpp.

References WLogger::addLogMessage(), wlog::debug(), WLogger::getLogger(), init(), m_graphicsEngine, m_gui, m_kernel, and WThreadedRunner::setThreadName().

Referenced by instance().


Member Function Documentation

boost::shared_ptr< WModule > WKernel::applyModule ( boost::shared_ptr< WModule applyOn,
boost::shared_ptr< WModule prototype 
)

Function combines to modules.

This is a simple alias for "getRootContainer()->applyModule". It runs synchronously, which could freeze the calling thread for a couple of time.

Parameters:
applyOnthe module which already has to be in the container and to apply the other one on.
prototypethe prototype of the module to apply on the other one specified.
Returns:
the newly created module connected with the one specified in applyOn.

Definition at line 175 of file WKernel.cpp.

References getRootContainer().

void WKernel::finalize ( )

Stops execution of the modules in the root container.

Note that this does not wait for the kernel thread since this could cause a dead lock. This is actually an alias for getRootContainer()->stop().

Definition at line 133 of file WKernel.cpp.

References WLogger::addLogMessage(), WDataHandler::getDataHandler(), WLogger::getLogger(), and getRootContainer().

boost::shared_ptr< WGraphicsEngine > WKernel::getGraphicsEngine ( ) const

Returns pointer to currently running instance of graphics engine.

Returns:
the graphics engine instance.

Definition at line 118 of file WKernel.cpp.

References m_graphicsEngine.

Referenced by WSelectionManager::getFrontSector(), and WSelectionManager::setPaintMode().

boost::shared_ptr< WGUI > WKernel::getGui ( ) const

Getter for the associated GUI.

Returns:
the GUI.

Definition at line 128 of file WKernel.cpp.

References m_gui.

boost::shared_ptr< WROIManager > WKernel::getRoiManager ( )

get for roi manager

Returns:
Pointer to the ROI manager.

Definition at line 180 of file WKernel.cpp.

References m_roiManager.

Referenced by WFiberSelector::slotAddRoi(), WFiberSelector::WFiberSelector(), and WFiberSelector::~WFiberSelector().

boost::shared_ptr< WModuleContainer > WKernel::getRootContainer ( ) const

Returns the root module container.

This is the actual module graph container.

Returns:
the root container.

Definition at line 123 of file WKernel.cpp.

References m_moduleContainer.

Referenced by applyModule(), finalize(), WProjectFile::load(), loadDataSets(), loadDataSetsSynchronously(), WProjectFile::onThreadException(), WModuleProjectFileCombiner::save(), and WProjectFile::threadMain().

WKernel * WKernel::getRunningKernel ( ) [static]
boost::shared_ptr< WSelectionManager > WKernel::getSelectionManager ( )

get for selection manager

Returns:
Pointer to the selection manager.

Definition at line 185 of file WKernel.cpp.

References m_selectionManager.

WTimer::ConstSPtr WKernel::getTimer ( ) const

Returns the system timer.

If you need timing for animations and similar, use this one. This timer can change to frame based timing if the user plays back some animation. So, everything which uses this timer can always do accurate per-frame animations even if frame time and real-time differ.

Returns:
the timer

Definition at line 190 of file WKernel.cpp.

References m_timer.

void WKernel::init ( ) [private]

Initializes the graphics engine, data handler and so on.

Definition at line 90 of file WKernel.cpp.

References WDataHandler::getDataHandler(), WModuleFactory::getModuleFactory(), m_moduleContainer, m_moduleFactory, m_roiManager, and m_selectionManager.

Referenced by WKernel().

WKernel * WKernel::instance ( boost::shared_ptr< WGraphicsEngine ge,
boost::shared_ptr< WGUI gui 
) [static]

Returns pointer to the running kernel or a new if no kernel was there.

If a running kernel exists the function return it and does not check if ge and gui of the running kernel are equivalent to the ones given as parameters.

Parameters:
geinitialized graphics engine.
guiinitialized gui.
Returns:
the kernel instance.

Definition at line 80 of file WKernel.cpp.

References m_kernel, and WKernel().

const WBoolFlag & WKernel::isFinishRequested ( ) const

Determines whether all threads should finish.

Returns:
true if so.

Definition at line 160 of file WKernel.cpp.

References WThreadedRunner::m_shutdownFlag.

WBatchLoader::SPtr WKernel::loadDataSets ( std::vector< std::string >  filenames,
bool  suppressColormaps = false 
)

Load specified datasets.

It immediately returns and starts another thread, which actually loads the data.

Parameters:
filenameslist of filenames to load. The registered notification handler for the root container will get notified on error and success.
suppressColormapsif true, the data modules are instructed to avoid registration of colormaps. This can be very handy if you combine multiple data loaders into one new data loader or data set
Returns:
the batch loader responsible for loading. Can be queried for the list of data modules.

Definition at line 165 of file WKernel.cpp.

References getRootContainer().

WBatchLoader::SPtr WKernel::loadDataSetsSynchronously ( std::vector< std::string >  filenames,
bool  suppressColormaps = false 
)

Loads the specified files synchronously.

Parameters:
filenameslist of filenames to load. The registered notification handler for the root container will get notified on error and success.
suppressColormapsif true, the data modules are instructed to avoid registration of colormaps. This can be very handy if you combine multiple data loaders into one new data loader or data set
Returns:
the batch loader responsible for loading. Can be queried for the list of data modules.

Definition at line 170 of file WKernel.cpp.

References getRootContainer().

void WKernel::loadModules ( ) [private]

Loads all the modules it can find.

void WKernel::threadMain ( ) [protected, virtual]

Function that has to be overwritten for execution.

It gets executed in a separate thread after run() has been called.

Reimplemented from WThreadedRunner.

Definition at line 144 of file WKernel.cpp.

References WLogger::addLogMessage(), WLogger::getLogger(), m_graphicsEngine, m_gui, and WThreadedRunner::waitForStop().


Member Data Documentation

boost::shared_ptr< WGraphicsEngine > WKernel::m_graphicsEngine [protected]

Pointer to an initialized graphics engine.

Definition at line 204 of file WKernel.h.

Referenced by getGraphicsEngine(), threadMain(), and WKernel().

boost::shared_ptr< WGUI > WKernel::m_gui [protected]

The Gui.

Definition at line 199 of file WKernel.h.

Referenced by getGui(), threadMain(), and WKernel().

WKernel * WKernel::m_kernel = NULL [static, private]

Pointer to the unique instance of this singleton class.

Used for program wide access to the kernel.

Definition at line 240 of file WKernel.h.

Referenced by getRunningKernel(), instance(), and WKernel().

boost::shared_ptr< WModuleContainer > WKernel::m_moduleContainer [protected]

The container containing the modules.

Definition at line 224 of file WKernel.h.

Referenced by getRootContainer(), and init().

boost::shared_ptr< WModuleFactory > WKernel::m_moduleFactory [protected]

The module factory to use.

Definition at line 219 of file WKernel.h.

Referenced by init().

boost::shared_ptr< WROIManager > WKernel::m_roiManager [protected]

Pointer to a roi manager.

Definition at line 209 of file WKernel.h.

Referenced by getRoiManager(), and init().

boost::shared_ptr< WSelectionManager > WKernel::m_selectionManager [protected]

pointer to a selection manager

Definition at line 214 of file WKernel.h.

Referenced by getSelectionManager(), and init().

The ow system timer.

Definition at line 245 of file WKernel.h.

Referenced by getTimer().


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