AVxcelerate Simulation Framework 2024 R1

world_simulator::IWorldSimulator Class Reference

Last update: 16.07.2025

This serves as the interface for a world/groundtruth simulator implementation in simulation framework. It ensures that any third party ground truth generator lib could follow this API definition and thus could be easily used in simulation framework. Interface of scenario should follow ASAM OSI3 standard (https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html) More...

#include <i_world_simulator.h>

Public Member Functions

virtual void InitSimulator ()=0
 
virtual void Tick ()=0
 
virtual bool IsSimulationFinished () const =0
 
virtual void Shutdown ()=0
 
virtual const avx_osi3::SensorView & GetSensorView () const =0
 
virtual const std::vector< avx_osi3::TrafficCommand > & GetTrafficCommands () const =0
 
virtual std::chrono::milliseconds GetCurrentTime () const =0
 
virtual void SetTrafficUpdate (const avx_osi3::TrafficUpdate &traffic_update)=0
 

Detailed Description

This serves as the interface for a world/groundtruth simulator implementation in simulation framework. It ensures that any third party ground truth generator lib could follow this API definition and thus could be easily used in simulation framework. Interface of scenario should follow ASAM OSI3 standard (https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html)

Member Function Documentation

◆ GetCurrentTime()

virtual std::chrono::milliseconds world_simulator::IWorldSimulator::GetCurrentTime ( ) const
pure virtual

Return the state if simulation is finished

Returns
true if the simulation ends

◆ GetSensorView()

virtual const avx_osi3::SensorView& world_simulator::IWorldSimulator::GetSensorView ( ) const
pure virtual

Return sensor view in osi3 format

Returns
avx_osi3::SensorView type

◆ GetTrafficCommands()

virtual const std::vector<avx_osi3::TrafficCommand>& world_simulator::IWorldSimulator::GetTrafficCommands ( ) const
pure virtual

Return traffic commands in osi3 format

Returns
an vector of avx_osi3::TrafficCommand type

◆ InitSimulator()

virtual void world_simulator::IWorldSimulator::InitSimulator ( )
pure virtual

Initialization of the simulator

◆ IsSimulationFinished()

virtual bool world_simulator::IWorldSimulator::IsSimulationFinished ( ) const
pure virtual

Return the state if simulation is finished

Returns
true if the simulation ends

◆ SetTrafficUpdate()

virtual void world_simulator::IWorldSimulator::SetTrafficUpdate ( const avx_osi3::TrafficUpdate &  traffic_update)
pure virtual

set new traffic update into simulator

Parameters
traffic_updatetraffic update data in avx_osi3::TrafficUpdate format

◆ Shutdown()

virtual void world_simulator::IWorldSimulator::Shutdown ( )
pure virtual

Any logic needs to be called in the termination

◆ Tick()

virtual void world_simulator::IWorldSimulator::Tick ( )
pure virtual

Main step function which drive the simulator's calculation for one minimum cycle time

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

Connect with Ansys