.. index:: pair: class; EngineClient::EngineLauncher .. _doxid-class_engine_client_1_1_engine_launcher: template class EngineClient::EngineLauncher =========================================== .. toctree:: :hidden: Overview ~~~~~~~~ Class for launching engine. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include template class EngineLauncher: public :ref:`EngineLauncherInterface` { public: // construction :target:`EngineLauncher`(); :target:`EngineLauncher`(const :ref:`engine_type_t`& engineType); // methods virtual :ref:`EngineClientInterfaceSharedPtr` :ref:`launchEngine`( :ref:`nlohmann::json`& engineConfig, :ref:`ProcessLauncherInterface::unique_ptr`&& launcher ); }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // typedefs typedef std::shared_ptr :ref:`shared_ptr`; typedef std::shared_ptr :ref:`const_shared_ptr`; typedef std::unique_ptr :ref:`unique_ptr`; typedef std::unique_ptr :ref:`const_unique_ptr`; typedef decltype(:ref:`DataPackIdentifier::Type`) :ref:`engine_type_t`; // methods const :ref:`engine_type_t`& :ref:`engineType`() const; virtual :ref:`EngineClientInterfaceSharedPtr` :ref:`launchEngine`( :ref:`nlohmann::json`& engineConfig, :ref:`ProcessLauncherInterface::unique_ptr`&& launcher ) = 0; .. _details-class_engine_client_1_1_engine_launcher: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Class for launching engine. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ENGINE_TYPE - Default engine type Methods ------- .. index:: pair: function; launchEngine .. _doxid-class_engine_client_1_1_engine_launcher_1a3c2050ae4d2d3b825adf6678e51851b2: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`EngineClientInterfaceSharedPtr` launchEngine( :ref:`nlohmann::json`& engineConfig, :ref:`ProcessLauncherInterface::unique_ptr`&& launcher ) Launches an engine. Configures config and forks a new child process for the engine. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - engineConfig - Engine Configuration * - launcher - Process Forker .. rubric:: Returns: Returns pointer to :ref:`EngineClientInterface `