NRP Core  1.4.1
Guides

For users interested in creating their own engine for an as-of-yet unsupported simulator, the following guides / tutorials will be helpful.

For users interested in integrating simulators with Python API, this guide should be of interest: Using the Python JSON engine.

Finally, this page contains other tips and helpful information for the use of NRP-core Helpful information

EngineClientInterface::getDataPacksFromEngine
virtual datapacks_vector_t getDataPacksFromEngine(const datapack_identifiers_set_t &datapackIdentifiers)=0
Gets requested datapacks from engine.
datapacks_vector_t
std::vector< std::shared_ptr< const DataPackInterface > > datapacks_vector_t
Definition: datapack_interface.h:220
EngineClientInterface::shutdown
virtual void shutdown()=0
Shutdown engine.
nrp_logger.h
NRPLogger::warn
static void warn(const FormatString &fmt, const Args &...args)
NRP logging function with message formatting for warning level.
Definition: nrp_logger.h:149
datapacks_set_t
std::set< std::shared_ptr< const DataPackInterface >, DataPackPointerComparator > datapacks_set_t
Definition: datapack_interface.h:219
PtrTemplates< ProcessLauncherInterface >::unique_ptr
std::unique_ptr< ProcessLauncherInterface > unique_ptr
Definition: ptr_templates.h:34
gazebo
Definition: camera_datapack_controller.h:34
BOOST_PYTHON_MODULE
BOOST_PYTHON_MODULE(PYTHON_MODULE_NAME)
Definition: python_module.cpp:87
EngineClientInterface::sendDataPacksToEngine
virtual void sendDataPacksToEngine(const datapacks_set_t &dataPacks)=0
Sends datapacks to engine.
python_json_engine.shutdown
def shutdown()
Definition: python_json_engine.py:104
python_json_engine.reset
def reset()
Definition: python_json_engine.py:99
TransceiverFunction
Holds a single transfer function decorator.
Definition: transceiver_function.h:36
plugin.h
TIMEOUT
const auto TIMEOUT
Definition: nrp_mqtt_client.h:37
EngineClientInterface::reset
virtual void reset()=0
Reset engine.
EngineClient
Base class for all Engines.
Definition: engine_client_interface.h:191
python_grpc_engine.type
type
Definition: python_grpc_engine.py:63
EngineDataPack
Class for input datapacks for transceiver functions, mapped to EngineDataPack python decorator.
Definition: from_engine_datapack.h:38
engine_client_interface.h
NRPLogger::info
static void info(const FormatString &fmt, const Args &...args)
NRP logging function with message formatting for info level.
Definition: nrp_logger.h:138
CREATE_NRP_ENGINE_LAUNCHER
#define CREATE_NRP_ENGINE_LAUNCHER(engine_launcher_name)
Create a new engine launcher. Will be used to load a launcher out of a dynamically loaded library.
Definition: plugin.h:35
NRP_LOG_TIME
#define NRP_LOG_TIME(filename)
Definition: time_utils.h:165
python_json_engine.initialize
def initialize()
Definition: python_json_engine.py:79
EngineClient::runLoopStepCallback
virtual SimulationTime runLoopStepCallback(SimulationTime timeStep)=0
Executes a single loop step.
datapack_identifiers_set_t
std::set< DataPackIdentifier > datapack_identifiers_set_t
Definition: datapack_interface.h:221
EngineClientInterface::initialize
virtual void initialize()=0
Initialize engine.
python_grpc_engine.str
str
Definition: python_grpc_engine.py:63
NRPLogger
NRP Logging functions.
Definition: nrp_logger.h:45
NRPLogger::NRPLogger
NRPLogger(std::string loggerName=_defaultLoggerName.data())
The creation of the configurable instance of spdlog, that is set to default logger,...
Definition: nrp_logger.cpp:149
NRPLogger::critical
static void critical(const FormatString &fmt, const Args &...args)
NRP logging function with message formatting for critical error level.
Definition: nrp_logger.h:171
main
int main(int argc, char *argv[])
Definition: main.cpp:28
DataPackIdentifier
Identifies a single datapack.
Definition: datapack_interface.h:38
NRPLogger::error
static void error(const FormatString &fmt, const Args &...args)
NRP logging function with message formatting for error level.
Definition: nrp_logger.h:160
NRPLogger::level_t
spdlog::level::level_enum level_t
The wrapper type for log levels.
Definition: nrp_logger.h:52
python_json_engine.options
dict options
Definition: python_json_engine.py:200
NRP_LOG_TIME_BLOCK
#define NRP_LOG_TIME_BLOCK(filename)
Definition: time_utils.h:167
NRPLogger::debug
static void debug(const FormatString &fmt, const Args &...args)
NRP logging function with message formatting for debug level.
Definition: nrp_logger.h:127
SimulationTime
std::chrono::nanoseconds SimulationTime
Definition: time_utils.h:31
EngineClientInterface::engineProcStartParams
virtual const std::vector< std::string > engineProcStartParams() const =0
Get all Engine Process Startup parameters.
NRP_LOGGER_TRACE
#define NRP_LOGGER_TRACE(...)
trace log macro. It is voided by defining \PRODUCTION_RELEASE
Definition: nrp_logger.h:39
json
nlohmann::json json
Definition: engine_json_server.cpp:31