SimulationDataManager Class Reference

Manages all simulation data. More...

#include <simulation_data_manager.h>

Public Member Functions
void	pushToTrajectory (datapacks_vector_t dataPacks)
	Appends the input vector to the trajectory. More...
const datapacks_vector_t &	getTrajectory () const
	Returns the trajectory vector. More...
void	clearTrajectory ()
	Clears the trajectory vector. More...
void	setDoneFlag (bool doneFlag)
	Sets value of the 'done' flag. More...
bool	getDoneFlag () const
	Returns value of the 'done' flag. More...
void	clear ()
	Clears all data stored in the manager. More...
void	updateExternalPool (datapacks_vector_t dataPacks)
	Updates the pool of DataPacks coming from an external source (e.g. a master script) More...
void	updatePreprocessingPool (datapacks_vector_t dataPacks)
	Updates the pool of DataPacks coming from the Preprocessing Functions. More...
void	updateTransceiverPool (datapacks_vector_t dataPacks)
	Updates the pool of DataPacks coming from the Transceiver Functions. More...
void	updateEnginePool (datapacks_vector_t dataPacks)
	Updates the pool of DataPacks coming from Engines. More...
datapacks_set_t	getEngineDataPacks (const std::string &engineName) const
	Returns a set of DataPacks that are intended to be sent to the Engine with given name. More...
datapacks_set_t	getTransceiverDataPacks () const
	Returns a set of DataPacks that are intended to be accessed by the Transceiver Functions. More...
datapacks_set_t	getPreprocessingDataPacks () const
	Returns a set of DataPacks that are intended to be accessed by the Preprocessing Functions. More...
datapacks_set_t	getStatusDataPacks () const
	Returns a set of DataPacks that are intended to be accessed by the Status Function. More...
void	startNewIteration ()
	Performs bookkeeping at start of the simulation iteration. More...

Detailed Description

Manages all simulation data.

This class is responsible for managing all simulation data. In particular, it manages all DataPacks that are produced during the course of the simulation.

The DataPacks are stored in five separate pools:

• Engine Pool for DataPacks coming from the Engines
• Preprocessing Pool for DataPacks coming from the Preprocessing Functions
• Transceiver Pool for DataPacks coming from the Transceiver Functions
• External Pool for DataPacks coming from external processes, most likely a Master Script
• Trajectory for DataPacks coming from the Status Function

The first four pools are meant to store the most recent simulation data coming from various sources. They are implemented as sets, so he DataPacks stored in these pools are overwritten (updated) whenever a new DataPack with matching ID is inserted.

The Trajectory is used to store a history of observations produced by the Status Function. It is implemented using a vector, so the order of DataPacks is preserved. The DataPacks from this pool is intended to be sent back to the Master Script whenever the done flag coming from the Status Function is set.

Member Function Documentation

clear()

void SimulationDataManager::clear

(

)

Clears all data stored in the manager.

clearTrajectory()

void SimulationDataManager::clearTrajectory

(

)

Clears the trajectory vector.

getDoneFlag()

bool SimulationDataManager::getDoneFlag

(

)

const

Returns value of the 'done' flag.

getEngineDataPacks()

datapacks_set_t SimulationDataManager::getEngineDataPacks

(

const std::string &

engineName

)

const

Returns a set of DataPacks that are intended to be sent to the Engine with given name.

The method combines DataPacks from the Transceiver and External pools, and filters them by the Engine name given as argument.

getPreprocessingDataPacks()

datapacks_set_t SimulationDataManager::getPreprocessingDataPacks

(

)

const

Returns a set of DataPacks that are intended to be accessed by the Preprocessing Functions.

The method returns DataPacks from the Engine pool.

getStatusDataPacks()

datapacks_set_t SimulationDataManager::getStatusDataPacks

(

)

const

Returns a set of DataPacks that are intended to be accessed by the Status Function.

The method combines DataPacks from the Engine, Preprocessing and Transceiver pools.

getTrajectory()

const datapacks_vector_t & SimulationDataManager::getTrajectory

(

)

const

Returns the trajectory vector.

getTransceiverDataPacks()

datapacks_set_t SimulationDataManager::getTransceiverDataPacks

(

)

const

Returns a set of DataPacks that are intended to be accessed by the Transceiver Functions.

The method combines DataPacks from the Engine and Preprocessing pools.

pushToTrajectory()

void SimulationDataManager::pushToTrajectory

(

datapacks_vector_t

dataPacks

)

Appends the input vector to the trajectory.

setDoneFlag()

void SimulationDataManager::setDoneFlag

(

bool

doneFlag

)

Sets value of the 'done' flag.

startNewIteration()

void SimulationDataManager::startNewIteration

(

)

Performs bookkeeping at start of the simulation iteration.

This method should be called at the start of each simulation iteration. It resets the isUpdated flags on all stored DataPacks.

updateEnginePool()

void SimulationDataManager::updateEnginePool

(

datapacks_vector_t

dataPacks

)

Updates the pool of DataPacks coming from Engines.

The method will overwrite DataPacks that are already in the pool, if their ID matches the ID of any of the DataPacks passed as argument, and if the new DataPacks are not empty.

Parameters

dataPacks

A list of DataPacks that will be inserted into the Engine pool

updateExternalPool()

void SimulationDataManager::updateExternalPool

(

datapacks_vector_t

dataPacks

)

Updates the pool of DataPacks coming from an external source (e.g. a master script)

The method will overwrite DataPacks that are already in the pool, if their ID matches the ID of any of the DataPacks passed as argument.

Parameters

dataPacks

A list of DataPacks that will be inserted into the External pool

updatePreprocessingPool()

void SimulationDataManager::updatePreprocessingPool

(

datapacks_vector_t

dataPacks

)

Updates the pool of DataPacks coming from the Preprocessing Functions.

The method will overwrite DataPacks that are already in the pool, if their ID matches the ID of any of the DataPacks passed as argument.

Parameters

dataPacks

A list of DataPacks that will be inserted into the Preprocessing pool

updateTransceiverPool()

void SimulationDataManager::updateTransceiverPool

(

datapacks_vector_t

dataPacks

)

Updates the pool of DataPacks coming from the Transceiver Functions.

The method will overwrite DataPacks that are already in the pool, if their ID matches the ID of any of the DataPacks passed as argument.

Parameters

dataPacks

A list of DataPacks that will be inserted into the Transceiver pool

---

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

• nrp_simulation/nrp_simulation/datapack_handle/simulation_data_manager.h
• nrp_simulation/nrp_simulation/datapack_handle/simulation_data_manager.cpp