.. index:: pair: struct; SimulationParams
.. _doxid-struct_simulation_params:

struct SimulationParams
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

NRP Simulation Startup Parameters. :ref:`More...<details-struct_simulation_params>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <simulation_parameters.h>
	
	struct SimulationParams {
		// typedefs
	
		typedef bool :target:`ParamHelpT<doxid-struct_simulation_params_1a98eade2137587ec773c048f50fd9f5e2>`;
		typedef std::string :target:`ParamSimCfgFileT<doxid-struct_simulation_params_1ada4c4d14ad6f7a6c53daa395a98b01db>`;
		typedef std::vector<std::string> :target:`ParamPluginsT<doxid-struct_simulation_params_1ab7cddd90535bd0de8471dfcd19922590>`;
		typedef std::string :target:`ParamExpDirT<doxid-struct_simulation_params_1a556afe1ead653ec292e505173aa5d4f5>`;
		typedef std::string :target:`ParamConsoleLogLevelT<doxid-struct_simulation_params_1a33c2767e0615b435d3e577399e7fa7c6>`;
		typedef std::string :target:`ParamFileLogLevelT<doxid-struct_simulation_params_1a2a81295be82f0599af9dbd686fa58301>`;
		typedef std::string :target:`ParamLogOutputT<doxid-struct_simulation_params_1a5cbe9d23f35a16666237500b9669aadc>`;
		typedef std::string :target:`ParamFilenameT<doxid-struct_simulation_params_1aeb14d8fa363d8d2fe4c684bce3227e81>`;
		typedef std::string :target:`ParamLogDirT<doxid-struct_simulation_params_1aa6655eec4c3816de925463de6f9d29b7>`;
		typedef bool :target:`ParamLogConfigT<doxid-struct_simulation_params_1aa512738944e8af699a97d8c7c0d46cf2>`;
		typedef std::string :target:`ParamModeT<doxid-struct_simulation_params_1abcad1c99ad6c96dd4acd464d74170a18>`;
		typedef std::vector<std::string> :target:`ParamSimParamT<doxid-struct_simulation_params_1a5dc7bc2d48177ffe3a2d19e7a3c05804>`;
		typedef std::string :target:`ParamServerAddressT<doxid-struct_simulation_params_1a33841425df038a18ba057e74df43cf47>`;
		typedef bool :target:`ParamSlaveT<doxid-struct_simulation_params_1a7053a1fa0c2d33d89c157493e687f2bb>`;

		// fields
	
		static constexpr std::string_view :target:`NRPProgramName<doxid-struct_simulation_params_1a05916ef3a7e8d8d73d9ff2ba66dcb1e2>` = "NRPCoreSim";
		static constexpr std::string_view :target:`ProgramDescription<doxid-struct_simulation_params_1aab5cb8ec04b7258de928ff1a0796300e>` = "Brain and physics simulator";
		static constexpr std::string_view :target:`ParamHelp<doxid-struct_simulation_params_1a2e7cbda85ae9f5cb11a705028b2f94ef>` = "h";
		static constexpr std::string_view :target:`ParamHelpLong<doxid-struct_simulation_params_1a9f563937c1d281f836efd7bec27b39ea>` = "h,help";
		static constexpr std::string_view :target:`ParamHelpDesc<doxid-struct_simulation_params_1ae518faed0097933660cec54c5cd3ab30>` = "Print this message";
		static constexpr std::string_view :target:`ParamSimCfgFile<doxid-struct_simulation_params_1ae62c32bb912e42f5f16689fe75046c85>` = "c";
		static constexpr std::string_view :target:`ParamSimCfgFileLong<doxid-struct_simulation_params_1a9fac3c8c3b307fdfd1da51e11c651a83>` = "c,config";
		static constexpr std::string_view :target:`ParamSimCfgFileDesc<doxid-struct_simulation_params_1a7f7fbd66d82dd25317cbad87148bc57d>` = "Simulation config file";
		static constexpr std::string_view :target:`ParamPlugins<doxid-struct_simulation_params_1a23c6e739580f8789d98ec6bcf136f3b6>` = "p";
		static constexpr std::string_view :target:`ParamPluginsLong<doxid-struct_simulation_params_1a659f6e701a633d24ecf2c1f70236bd59>` = "p,plugins";
		static constexpr std::string_view :target:`ParamPluginsDesc<doxid-struct_simulation_params_1aaed74c75e28e82785f0858279d8a53c3>` = "Engine plugins to load. If omitted, all engines compiled with nrp-core are loaded";
		static constexpr std::string_view :target:`ParamExpDir<doxid-struct_simulation_params_1aa7715dcf215007f249f09ca0d0461439>` = "d";
		static constexpr std::string_view :target:`ParamExpDirLong<doxid-struct_simulation_params_1a6ab636f9fd4fb875f996336835855fc0>` = "d,dir";
		static constexpr std::string_view :target:`ParamExpDirDesc<doxid-struct_simulation_params_1a4f97379be4add9bfda915ac3daba4180>` = "The explicit location of the experiment folder";
		static constexpr std::string_view :target:`ParamConsoleLogLevelLong<doxid-struct_simulation_params_1ad0c210f3627ea6ddabef6b87cce146e3>` = "cloglevel";
		static constexpr std::string_view :target:`ParamConsoleLogLevelDesc<doxid-struct_simulation_params_1a133584c296043735cd0ac85e41eec3c5>` = "Console minimum level of log severity";
		static constexpr std::string_view :target:`ParamFileLogLevelLong<doxid-struct_simulation_params_1a0f3b671c839acb07009c0a8364bb6ff0>` = "floglevel";
		static constexpr std::string_view :target:`ParamFileLogLevelDesc<doxid-struct_simulation_params_1a2fefabf3af147d3496efadd136c86e87>` = "File minimum level of log severity";
		static constexpr std::string_view :target:`ParamLogOutputLong<doxid-struct_simulation_params_1a1e3eefd0a51f97224925d02adc1a9875>` = "logoutput";
		static constexpr std::string_view :target:`ParamLogOutputDesc<doxid-struct_simulation_params_1a32b27304cbd7fd8fda38e58d0c7cfd2c>` = "Option for logging stdout and stderr in the experiment: engines, all, silent";
		static constexpr std::string_view :target:`ParamLogFilenameLong<doxid-struct_simulation_params_1aa38f36703d1220da19da68309e8681d6>` = "logfilename";
		static constexpr std::string_view :target:`ParamLogFilenameDesc<doxid-struct_simulation_params_1a6c73e8453228379faf16d36edc80e552>` = "If 'logoutput' option is 'engines' or 'all', name of the log file";
		static constexpr std::string_view :target:`ParamLogDirLong<doxid-struct_simulation_params_1a8cd6baa4e88c1d085696ac5a0b70aaf7>` = "logdir";
		static constexpr std::string_view :target:`ParamLogDirDesc<doxid-struct_simulation_params_1a622dfe3e7705b24bfdf952cba3a76726>` = "Directory for the file logs";
		static constexpr std::string_view :target:`ParamLogConfig<doxid-struct_simulation_params_1a89332ba6bbca1703a82da0de83145741>` = "l";
		static constexpr std::string_view :target:`ParamLogConfigLong<doxid-struct_simulation_params_1a17d083fcd1bb9550ed7ab47a97b24e17>` = "l,logconfig";
		static constexpr std::string_view :target:`ParamLogConfigDesc<doxid-struct_simulation_params_1aa9d78d47df4fded17566616ca97fbaf3>` = "Print the simulation config in :ref:`use<doxid-spinnaker__proxy_8h_1a93ae0dd742360abbf161f1d34f5e2831>` to DEBUG log";
		static constexpr std::string_view :target:`ParamMode<doxid-struct_simulation_params_1ace9e8908d4634abf3e96b43ca86f5683>` = "m";
		static constexpr std::string_view :target:`ParamModeLong<doxid-struct_simulation_params_1a804ecbc40452fa7f8a2bf024228bdf8e>` = "m,mode";
		static constexpr std::string_view :target:`ParamModeDesc<doxid-struct_simulation_params_1a6a8d59e9f9b6cd2ef585b5b6fad4a7f0>` = "Operational mode, standalone or server";
		static constexpr std::string_view :target:`ParamSimParam<doxid-struct_simulation_params_1a831d261580fb8ba92fe515a5fbaefd21>` = "o";
		static constexpr std::string_view :target:`ParamSimParamLong<doxid-struct_simulation_params_1adfa2372b6846b54bbb7154a0985bdcac>` = "o,param";
		static constexpr std::string_view :target:`ParamSimParamDesc<doxid-struct_simulation_params_1a26cf510fddacf470906e6b583bdb04fd>` = "Simulation config parameter, specified as param=value, overriding configuration file parameters";
		static constexpr std::string_view :target:`ParamServerAddressLong<doxid-struct_simulation_params_1a4c1cca0c06cf34df6b1eace97f38929e>` = "server_address";
		static constexpr std::string_view :target:`ParamServerAddressDesc<doxid-struct_simulation_params_1a02633bf63585e085b6f45a7e309a30e3>` = "Desired address of the server in server operational mode";
		static constexpr std::string_view :target:`ParamSlaveLong<doxid-struct_simulation_params_1a3023d72d2ccd9b7ba98493e8b5f08cde>` = "slave";
		static constexpr std::string_view :target:`ParamSlaveDesc<doxid-struct_simulation_params_1aa9026ac6eabebd883ebb91d3479b45bb>` = "If present NRPCoreSim runs in slave mode. For internal use.";

		// methods
	
		static cxxopts::Options :ref:`createStartParamParser<doxid-struct_simulation_params_1aa6c9b4b4d53513b7250dc1b4b466b4b8>`();
		static :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>` :ref:`setWorkingDirectoryAndGetConfigFile<doxid-struct_simulation_params_1af868a0348976b0a9c162a1d72e7d7732>`(const cxxopts::ParseResult& args);
	
		static void :ref:`parseAndSetCLISimParams<doxid-struct_simulation_params_1a4e9c2810426ad98a480647b97851cb85>`(
			const :ref:`ParamSimParamT<doxid-struct_simulation_params_1a5dc7bc2d48177ffe3a2d19e7a3c05804>`& parseResults,
			:ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>`& simulationConfig
		);
	
		static :ref:`NRPLogger::level_t<doxid-class_n_r_p_logger_1a13becfae8f98ba5d14c86a101344a4b1>` :ref:`parseLogLevel<doxid-struct_simulation_params_1a8c90775f6cc1f12bee42135e262c30e7>`(const std::string& logLevel);
	};
.. _details-struct_simulation_params:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

NRP Simulation Startup Parameters.

Methods
-------

.. index:: pair: function; createStartParamParser
.. _doxid-struct_simulation_params_1aa6c9b4b4d53513b7250dc1b4b466b4b8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static cxxopts::Options createStartParamParser()

Create a parser for start parameters.



.. rubric:: Returns:

Returns parser

.. index:: pair: function; setWorkingDirectoryAndGetConfigFile
.. _doxid-struct_simulation_params_1af868a0348976b0a9c162a1d72e7d7732:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`jsonSharedPtr<doxid-json__schema__utils_8h_1a1a31aaa02300075f725729b8d8ea57c5>` setWorkingDirectoryAndGetConfigFile(const cxxopts::ParseResult& args)

Get the simulation configuration from start parameters as a JSON object.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- args

		- Parsed start parameters



.. rubric:: Returns:

Returns instance of simulation config

.. index:: pair: function; parseAndSetCLISimParams
.. _doxid-struct_simulation_params_1a4e9c2810426ad98a480647b97851cb85:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static void parseAndSetCLISimParams(
		const :ref:`ParamSimParamT<doxid-struct_simulation_params_1a5dc7bc2d48177ffe3a2d19e7a3c05804>`& parseResults,
		:ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>`& simulationConfig
	)

Parse cmd line simulation parameters.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- parseResults

		- 

	*
		- simulationConfig

		-

.. index:: pair: function; parseLogLevel
.. _doxid-struct_simulation_params_1a8c90775f6cc1f12bee42135e262c30e7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`NRPLogger::level_t<doxid-class_n_r_p_logger_1a13becfae8f98ba5d14c86a101344a4b1>` parseLogLevel(const std::string& logLevel)

parsing input parameter string log level into enum type



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- logLevel

		- The string expression of the log level