NRP Core  1.4.1
FTILoop Class Reference

Manages simulation loop. Runs physics and brain interface, and synchronizes them via Transfer Functions. More...

#include <fti_loop.h>

Inheritance diagram for FTILoop:
PtrTemplates< FTILoop >

Public Member Functions

 FTILoop ()=default
 
 FTILoop (jsonSharedPtr config, DataPackProcessor::engine_interfaces_t engines, SimulationDataManager *simulationDataManager)
 
void initLoop ()
 Initialize engines before running loop. More...
 
void resetLoop ()
 Reset engines of the loop. More...
 
void shutdownLoop ()
 Shutdown engines. More...
 
void waitForEngines ()
 Blocks until all running Engines finishe their execution. More...
 
void runLoop (SimulationTime runLoopTime)
 Runs simulation for a total of runLoopTime (in s) More...
 
SimulationTime getSimTime () const
 Get Simulation Time (in seconds) More...
 

Friends

class FTILoopTest_InitTFManager_Test
 

Additional Inherited Members

- Public Types inherited from PtrTemplates< FTILoop >
using shared_ptr = std::shared_ptr< FTILoop >
 
using const_shared_ptr = std::shared_ptr< const FTILoop >
 
using unique_ptr = std::unique_ptr< FTILoop >
 
using const_unique_ptr = std::unique_ptr< const FTILoop >
 

Detailed Description

Manages simulation loop. Runs physics and brain interface, and synchronizes them via Transfer Functions.

Constructor & Destructor Documentation

◆ FTILoop() [1/2]

FTILoop::FTILoop ( )
default

◆ FTILoop() [2/2]

FTILoop::FTILoop ( jsonSharedPtr  config,
DataPackProcessor::engine_interfaces_t  engines,
SimulationDataManager simulationDataManager 
)

Member Function Documentation

◆ getSimTime()

SimulationTime FTILoop::getSimTime ( ) const
inline

Get Simulation Time (in seconds)

Returns
Returns time passed in simulation (in seconds)

◆ initLoop()

void FTILoop::initLoop ( )

Initialize engines before running loop.

◆ resetLoop()

void FTILoop::resetLoop ( )

Reset engines of the loop.

◆ runLoop()

void FTILoop::runLoop ( SimulationTime  runLoopTime)

Runs simulation for a total of runLoopTime (in s)

Parameters
runLoopTimeTime (in s) to run simulation. At end, will run TransceiverFunctions

◆ shutdownLoop()

void FTILoop::shutdownLoop ( )

Shutdown engines.

◆ waitForEngines()

void FTILoop::waitForEngines ( )

Blocks until all running Engines finishe their execution.

Friends And Related Function Documentation

◆ FTILoopTest_InitTFManager_Test

friend class FTILoopTest_InitTFManager_Test
friend

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