    

 ## On this page

  

 

 # vss::simulation Namespace Reference

 Last update: 16.07.2025 

## <a id="nested-classes" name="nested-classes"></a>Classes

struct [AssetInfo](a00610.xhtml) Describes one asset. [More...](a00610.xhtml#details)  
 struct [AutomaticBatching](a00698.xhtml) Automatic batching: the number of batches on rays and on rx channels is computed by the system, taking into account the specified constraints. [More...](a00698.xhtml#details)  
 struct [CameraGroundTruthParameters](a00670.xhtml) Describes the ground truth parameters for a physics-based camera. [More...](a00670.xhtml#details)  
 struct [CartesianGrid](a00714.xhtml) Cartesian grid message. [More...](a00714.xhtml#details)  
 struct [Configuration](a00602.xhtml) [Configuration](a00602.xhtml "Configuration message containing all parameters needed to load resources in AVX.") message containing all parameters needed to load resources in AVX. [More...](a00602.xhtml#details)  
 struct [DeployConfiguration](a00626.xhtml) Describes the parameters used to configure AVX deployment. [More...](a00626.xhtml#details)  
 struct [DeployHost](a00634.xhtml) Defines the deploy nodes on a remote host. [More...](a00634.xhtml#details)  
 struct [DeployNode](a00638.xhtml) Defines the deploy node parameters. [More...](a00638.xhtml#details)  
 struct [DisplayInformation](a00658.xhtml) Defines the display settings of a camera sensor. [More...](a00658.xhtml#details)  
 struct [EndPointRange](a00622.xhtml) Describes the parameters used to configure AVX deployment. [More...](a00622.xhtml#details)  
 struct [EnvironmentUpdate](a00754.xhtml) Applies an update to the environment. [More...](a00754.xhtml#details)  
 struct [GpuIdentifier](a00642.xhtml) Represents an identifier for a GPU. [More...](a00642.xhtml#details)  
 struct [Grid](a00710.xhtml) Describes the type of lidar sensor grid. [More...](a00710.xhtml#details)  
 struct [KinematicProperties](a00770.xhtml) Properties that define the motion of a solid. [More...](a00770.xhtml#details)  
 struct [LidarSimulation](a00706.xhtml) Describes simulation parameters for a lidar. [More...](a00706.xhtml#details)  
 struct [LightingSystem](a00618.xhtml) Describes a binary lighting system data. [More...](a00618.xhtml#details)  
 struct [LightingSystemParameters](a00726.xhtml) Contains lighting system simulation parameters. [More...](a00726.xhtml#details)  
 struct [LocalNodes](a00630.xhtml) The deploy parameters of the local workstation. [More...](a00630.xhtml#details)  
 struct [ManualBatching](a00694.xhtml) Manual batching: the number of batches for rays and rx channels is specified by the user. [More...](a00694.xhtml#details)  
 struct [ObjectKey](a00762.xhtml) Object key used to identify the nodes on which the update shall be applied. [More...](a00762.xhtml#details)  
 struct [ObjectUpdate](a00758.xhtml) Update to be applied on an object. [More...](a00758.xhtml#details)  
 struct [OutputSplitting](a00730.xhtml) The output data splitting configuration. [More...](a00730.xhtml#details)  
 struct [PbCameraSimulation](a00666.xhtml) Describes the simulation parameters for a physics-based camera. [More...](a00666.xhtml#details)  
 struct [PolarGrid](a00718.xhtml) Polar grid message. [More...](a00718.xhtml#details)  
 struct [RadarDebugViewParameters](a00690.xhtml) Describes the parameters for the radar's debug view. [More...](a00690.xhtml#details)  
 struct [RadarOutputSplitting](a00734.xhtml) The radar output data splitting configuration. [More...](a00734.xhtml#details)  
 struct [RadarSimulation](a00686.xhtml) Describes the simulation parameters for a radar and the type of batching method. [More...](a00686.xhtml#details)  
 struct [RecordingFormat](a00722.xhtml) Possible values for the recording output format. [More...](a00722.xhtml#details)  
 struct [RenderingParameters](a00678.xhtml) Sets the rendering engine parameters for a camera. [More...](a00678.xhtml#details)  
 class [ResourceUploader](a00738.xhtml) Upload Service. [More...](a00738.xhtml#details)  
 struct [RxBatching](a00702.xhtml) Batching on rx channels: applies independently for each radar mode. [More...](a00702.xhtml#details)  
 struct [SceneInfo](a00606.xhtml) Contains all components that make up a scene: the assets and the track. [More...](a00606.xhtml#details)  
 struct [SensorConfig](a00614.xhtml) Describes a binary sensor configuration data. [More...](a00614.xhtml#details)  
 struct [SensorParameters](a00654.xhtml) [Simulation](a00646.xhtml "This service provides the simulation control procedures.") parameters for a given sensor id. [More...](a00654.xhtml#details)  
 class [Simulation](a00646.xhtml) This service provides the simulation control procedures. [More...](a00646.xhtml#details)  
 struct [SimulationParameters](a00650.xhtml) Contains simulation parameters per sensor id. These parameters define the accuracy of the simulation, the types of sensor outputs to be generated and how they will be generated/stored. [More...](a00650.xhtml#details)  
 struct [State](a00774.xhtml) [State](a00774.xhtml "State defined on an object node.") defined on an object node. [More...](a00774.xhtml#details)  
 struct [Tag](a00766.xhtml) Definition of the tag using or not an index. [More...](a00766.xhtml#details)  
 struct [ThermalCameraSimulation](a00674.xhtml) Describes the simulation parameters for a thermal camera. [More...](a00674.xhtml#details)  
 struct [TopLeftCornerPosition](a00662.xhtml) Describes the top left corner position of the rendering window relative to the top left corner of the monitor. [More...](a00662.xhtml#details)  
 struct [UploadMetaData](a00746.xhtml) Provides information on the data to upload. [More...](a00746.xhtml#details)  
 struct [UploadRequest](a00742.xhtml) Upload request message. [More...](a00742.xhtml#details)  
 struct [WorldUpdate](a00750.xhtml) Contains an update of the world to be applied to AVX. [More...](a00750.xhtml#details)  
 ## <a id="enum-members" name="enum-members"></a>Enumerations

enum [Qualities](a00110.xhtml#abc43242d8d08dbce62bef12528367684) {   
 [UNDEFINED](a00110.xhtml#abc43242d8d08dbce62bef12528367684ad1ae31a31c309c8a363806cd8ab3d6f3) = 0, [LOW](a00110.xhtml#abc43242d8d08dbce62bef12528367684ae6fc8fb6ed8eeaf4fa38aedf1669381a) = 1, [MEDIUM](a00110.xhtml#abc43242d8d08dbce62bef12528367684a86c5a83b8fa0d4d0a4a12c8cd6259605) = 2, [HIGH](a00110.xhtml#abc43242d8d08dbce62bef12528367684abf278ae214602475245405172522b579) = 3,   
 [EXTREME](a00110.xhtml#abc43242d8d08dbce62bef12528367684a83a8efef6ebe18c4f9519626866298b6) = 4   
 } Possible values for quality factors. [More...](a00110.xhtml#abc43242d8d08dbce62bef12528367684)  
 enum [ColorMode](a00110.xhtml#ab9c0b1a15c582953407b339e28132404) { [BLACKWHITE](a00110.xhtml#ab9c0b1a15c582953407b339e28132404acf5a02e5f0bc8bdbf3b74c0728fe726e) = 0, [COATING](a00110.xhtml#ab9c0b1a15c582953407b339e28132404a9b8afaa5fbc5195ce7cd9becb99ab9d5) = 1, [VELOCITY](a00110.xhtml#ab9c0b1a15c582953407b339e28132404aa06e6d855d55e6bd80674ec291c1ba67) = 2, [NORMAL](a00110.xhtml#ab9c0b1a15c582953407b339e28132404af90529c5947b6f5243ca13f7bc0465cd) = 3 } The available color modes for the radar's debug view output. [More...](a00110.xhtml#ab9c0b1a15c582953407b339e28132404)  
 enum [RadarOutputSplittingLevel](a00110.xhtml#a9f79257d8ddad118e85eec0df5db95fb) { [DEFAULT](a00110.xhtml#a9f79257d8ddad118e85eec0df5db95fbaa6b85131903662cbfa97b6f799dd680a) = 0, [MODE](a00110.xhtml#a9f79257d8ddad118e85eec0df5db95fba026225496cf2e8a6d5306785e2e16d8e) = 1, [TRANSMITTER](a00110.xhtml#a9f79257d8ddad118e85eec0df5db95fba3182fd6094102e312f49f4b9dc469740) = 2 } The radar output splitting level. [More...](a00110.xhtml#a9f79257d8ddad118e85eec0df5db95fb)  
 ## <a id="var-members" name="var-members"></a>Variables

import avx vss simulation deploy\_parameters [proto](a00110.xhtml#a22592b5fe4265e80d3c84c69ff6c83ad)## Enumeration Type Documentation

<a id="ab9c0b1a15c582953407b339e28132404"></a>## [◆ ](#ab9c0b1a15c582953407b339e28132404)ColorMode

 enum [vss::simulation::ColorMode](a00110.xhtml#ab9c0b1a15c582953407b339e28132404)

The available color modes for the radar's debug view output.

Enumerator<a id="ab9c0b1a15c582953407b339e28132404acf5a02e5f0bc8bdbf3b74c0728fe726e"></a>BLACKWHITE Default value. Shade of gray by the angle of incidence between the surface and viewing direction.

<a id="ab9c0b1a15c582953407b339e28132404a9b8afaa5fbc5195ce7cd9becb99ab9d5"></a>COATING [Color](a00782.xhtml "Defines a color in RGB format.") by the dielectric properties of the material. Optionally shaded (see enable\_material\_shading).

<a id="ab9c0b1a15c582953407b339e28132404aa06e6d855d55e6bd80674ec291c1ba67"></a>VELOCITY [Color](a00782.xhtml "Defines a color in RGB format.") by the relative velocity. The RGB values correspond respectively to the velocities in XYZ direction.

<a id="ab9c0b1a15c582953407b339e28132404af90529c5947b6f5243ca13f7bc0465cd"></a>NORMAL [Color](a00782.xhtml "Defines a color in RGB format.") by the normal of the surface converted to RGB.





<a id="abc43242d8d08dbce62bef12528367684"></a>## [◆ ](#abc43242d8d08dbce62bef12528367684)Qualities

 enum [vss::simulation::Qualities](a00110.xhtml#abc43242d8d08dbce62bef12528367684)

Possible values for quality factors.

Enumerator<a id="abc43242d8d08dbce62bef12528367684ad1ae31a31c309c8a363806cd8ab3d6f3"></a>UNDEFINED Undefined value (default value will apply).

<a id="abc43242d8d08dbce62bef12528367684ae6fc8fb6ed8eeaf4fa38aedf1669381a"></a>LOW Low quality.

<a id="abc43242d8d08dbce62bef12528367684a86c5a83b8fa0d4d0a4a12c8cd6259605"></a>MEDIUM Medium quality.

<a id="abc43242d8d08dbce62bef12528367684abf278ae214602475245405172522b579"></a>HIGH High quality.

<a id="abc43242d8d08dbce62bef12528367684a83a8efef6ebe18c4f9519626866298b6"></a>EXTREME Extreme quality.





<a id="a9f79257d8ddad118e85eec0df5db95fb"></a>## [◆ ](#a9f79257d8ddad118e85eec0df5db95fb)RadarOutputSplittingLevel

 enum [vss::simulation::RadarOutputSplittingLevel](a00110.xhtml#a9f79257d8ddad118e85eec0df5db95fb)

The radar output splitting level.

Enumerator<a id="a9f79257d8ddad118e85eec0df5db95fbaa6b85131903662cbfa97b6f799dd680a"></a>DEFAULT Default value. Output data is not split.

<a id="a9f79257d8ddad118e85eec0df5db95fba026225496cf2e8a6d5306785e2e16d8e"></a>MODE Split by radar mode.

<a id="a9f79257d8ddad118e85eec0df5db95fba3182fd6094102e312f49f4b9dc469740"></a>TRANSMITTER Split by transmitter.





## Variable Documentation

<a id="a22592b5fe4265e80d3c84c69ff6c83ad"></a>## [◆ ](#a22592b5fe4265e80d3c84c69ff6c83ad)proto

 import google protobuf wrappers vss::simulation::proto