OpenPSTD::Kernel::KernelInterface Class Reference

The kernel API. More...

#include <KernelInterface.h>

Inheritance diagram for OpenPSTD::Kernel::KernelInterface:

Collaboration diagram for OpenPSTD::Kernel::KernelInterface:

Public Member Functions
virtual void	initialize_kernel (std::shared_ptr< PSTDConfiguration > config)=0
	Sets the configuration.
virtual void	run (KernelCallback *callback)=0
	Runs the kernel. More...
virtual SimulationMetadata	get_metadata ()=0
	Query the kernel for metadata about the simulation that is configured.

Detailed Description

The kernel API.

Member Function Documentation

virtual void OpenPSTD::Kernel::KernelInterface::run ( KernelCallback *  callback )

pure virtual

Runs the kernel.

The callback has a single function that informs the rest of the application of the progress of the kernel. Must first be configured, else a PSTDKernelNotConfiguredException is thrown.

Implemented in OpenPSTD::Kernel::PSTDKernel, and OpenPSTD::Kernel::MockKernel.

---

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

• /home/omar/Software/cpp/openPSTD/kernel/KernelInterface.h