TFManagerHandle Class Reference

Uses the TF framework to execute datapack transformation operations. More...

#include <tf_manager_handle.h>

Inheritance diagram for TFManagerHandle:

Public Member Functions
	TFManagerHandle (SimulationDataManager *simulationDataManager)
void	init (const jsonSharedPtr &simConfig, const engine_interfaces_t &engines) override
	Initializes the handler. More...
void	postEngineInit (const std::vector< EngineClientInterfaceSharedPtr > &engines) override
	Performs post-engine-initialization DataPack operations. More...
void	preEngineReset (const std::vector< EngineClientInterfaceSharedPtr > &engines) override
	Performs pre-engine-reset DataPack operations. More...
void	postEngineReset (const std::vector< EngineClientInterfaceSharedPtr > &engines) override
	Performs post-engine-reset DataPack operations. More...
void	updateDataPacksFromEngines (const std::vector< EngineClientInterfaceSharedPtr > &engines) override
	Request datapacks from engines. More...
void	compute (const std::vector< EngineClientInterfaceSharedPtr > &engines) override
	Perform computations on datapacks. More...
void	sendDataPacksToEngines (const std::vector< EngineClientInterfaceSharedPtr > &engines) override
	Send datapacks to engines. More...
Public Member Functions inherited from DataPackProcessor
	DataPackProcessor ()=delete
	DataPackProcessor (SimulationDataManager *simulationDataManager)
virtual	~DataPackProcessor ()=default
void	datapackCycle (const std::vector< EngineClientInterfaceSharedPtr > &engines)
	Execute sequentially the update, compute and send operations. More...
void	setSimulationTime (SimulationTime simulationTime)
void	setSimulationIteration (unsigned long simulationIteration)

Additional Inherited Members
Public Types inherited from DataPackProcessor
using	engine_interfaces_t = std::vector< EngineClientInterfaceSharedPtr >
Protected Attributes inherited from DataPackProcessor
SimulationDataManager *	_simulationDataManager
SimulationTime	_simulationTime = SimulationTime::zero()
unsigned long	_simulationIteration = 0L

Detailed Description

Uses the TF framework to execute datapack transformation operations.

Constructor & Destructor Documentation

TFManagerHandle()

TFManagerHandle::TFManagerHandle ( SimulationDataManager *  simulationDataManager )

inline

Member Function Documentation

compute()

void TFManagerHandle::compute ( const std::vector< EngineClientInterfaceSharedPtr > &  engines )

overridevirtual

Perform computations on datapacks.

Parameters

engines

Engines that are been synchronize in the current loop

Implements DataPackProcessor.

init()

void TFManagerHandle::init ( const jsonSharedPtr &  simConfig, const engine_interfaces_t &  engines  )

overridevirtual

Initializes the handler.

Parameters

simConfig	json object containing configuration information to initialize the handler
engines	list of Engine clients participating in the simulation

Implements DataPackProcessor.

postEngineInit()

void TFManagerHandle::postEngineInit ( const std::vector< EngineClientInterfaceSharedPtr > &  engines )

overridevirtual

Performs post-engine-initialization DataPack operations.

The method will retrieve DataPacks prepared by the engines' initialize() functions, and push them into the trajectory buffer, so that they can be returned to the main script.

Parameters

engines

Vector of engines for which the post-init step should be performed

Reimplemented from DataPackProcessor.

postEngineReset()

void TFManagerHandle::postEngineReset ( const std::vector< EngineClientInterfaceSharedPtr > &  engines )

overridevirtual

Performs post-engine-reset DataPack operations.

The method will retrieve DataPacks prepared by the engines' reset() functions, and push them into the trajectory buffer, so that they can be returned to the main script.

Parameters

engines

Vector of engines for which the post-reset step should be performed

Reimplemented from DataPackProcessor.

preEngineReset()

void TFManagerHandle::preEngineReset ( const std::vector< EngineClientInterfaceSharedPtr > &  engines )

overridevirtual

Performs pre-engine-reset DataPack operations.

The method will send Engine DataPacks to all engines. This allows the main script to send additional data or commands to the engines on reset().

Parameters

engines

Vector of engines for which the pre-init step should be performed

Reimplemented from DataPackProcessor.

sendDataPacksToEngines()

void TFManagerHandle::sendDataPacksToEngines ( const std::vector< EngineClientInterfaceSharedPtr > &  engines )

overridevirtual

Send datapacks to engines.

Parameters

engines

Engines that are been synchronize in the current loop

Implements DataPackProcessor.

updateDataPacksFromEngines()

void TFManagerHandle::updateDataPacksFromEngines ( const std::vector< EngineClientInterfaceSharedPtr > &  engines )

overridevirtual

Request datapacks from engines.

Parameters

engines

Engines that are been synchronize in the current loop

Implements DataPackProcessor.

---

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

• nrp_simulation/nrp_simulation/datapack_handle/tf_manager_handle.h
• nrp_simulation/nrp_simulation/datapack_handle/tf_manager_handle.cpp