Skip to main content

AVxcelerate Sensors Simulator API 2025 R1

vss::simulation::Simulation Class Reference

Last update: 14.01.2025

This service provides the simulation control procedures. More...

Public Member Functions

vss::Status Load (Configuration)
 
vss::Status Initialize (WorldUpdate)
 
vss::Status Update (WorldUpdate)
 
vss::Status Stop (google::protobuf::Empty)
 
vss::Status Unload (google::protobuf::Empty)
 
vss::Status Kill (google::protobuf::Empty)
 

Detailed Description

This service provides the simulation control procedures.

Note
The AVX state machine (simulation logic) must be considered when using simulation control procedures. Procedures that are not consistent with current AVX state will end in ERROR.

Member Function Documentation

◆ Load()

vss::Status vss::simulation::Simulation::Load ( Configuration  )

Loads AVX with a track, a list of assets, some simulation parameters, a sensor configuration, a lighting system (optional), some deployment parameters and the ID of the ego vehicle (the vehicle instance on which the sensor configuration will be attached).

◆ Initialize()

vss::Status vss::simulation::Simulation::Initialize ( WorldUpdate  )

Sets the initial position/orientation/states of all components of the world and changes AVX state to RUNNING.

◆ Update()

vss::Status vss::simulation::Simulation::Update ( WorldUpdate  )

Applies a world model update to AVX.

◆ Stop()

vss::Status vss::simulation::Simulation::Stop ( google::protobuf::Empty  )

Changes AVX state from RUNNING to LOADED.

◆ Unload()

vss::Status vss::simulation::Simulation::Unload ( google::protobuf::Empty  )

Unloads the simulation and switches AVX back to STARTED state.

Note
This command is used to restart a simulation without having to restart AVX.

◆ Kill()

vss::Status vss::simulation::Simulation::Kill ( google::protobuf::Empty  )

Sends a signal to end the AVX program properly. Closes the Grpc server.


The documentation for this class was generated from the following file:
  • simulation.proto

Connect with Ansys