## On this page
# vss::simulation Namespace Reference
Last update: 14.01.2025
## Classes
struct [AssetInfo](structvss_1_1simulation_1_1_asset_info.xhtml) Describes one asset. [More...](structvss_1_1simulation_1_1_asset_info.xhtml#details)
struct [AutomaticBatching](structvss_1_1simulation_1_1_automatic_batching.xhtml) Defines the automatic batching configuration. [More...](structvss_1_1simulation_1_1_automatic_batching.xhtml#details)
struct [CameraGroundTruthParameters](structvss_1_1simulation_1_1_camera_ground_truth_parameters.xhtml) Defines the types of ground truth output data the physics-based camera simulation will generate. [More...](structvss_1_1simulation_1_1_camera_ground_truth_parameters.xhtml#details)
struct [CartesianGrid](structvss_1_1simulation_1_1_cartesian_grid.xhtml) Defines the Cartesian grid. [More...](structvss_1_1simulation_1_1_cartesian_grid.xhtml#details)
struct [Configuration](structvss_1_1simulation_1_1_configuration.xhtml) Configuration message containing all parameters needed to load resources in AVX. [More...](structvss_1_1simulation_1_1_configuration.xhtml#details)
struct [DataAccessSettings](structvss_1_1simulation_1_1_data_access_settings.xhtml) Defines the mechanisms for accessing and managing sensor data. It supports configurations for storing data either on disk or in shared memory. [More...](structvss_1_1simulation_1_1_data_access_settings.xhtml#details)
struct [DeployConfiguration](structvss_1_1simulation_1_1_deploy_configuration.xhtml) Describes the parameters used to configure AVX deployment. [More...](structvss_1_1simulation_1_1_deploy_configuration.xhtml#details)
struct [DeployHost](structvss_1_1simulation_1_1_deploy_host.xhtml) Defines the deploy nodes on a remote host. [More...](structvss_1_1simulation_1_1_deploy_host.xhtml#details)
struct [DeployNode](structvss_1_1simulation_1_1_deploy_node.xhtml) Defines the deploy node parameters. [More...](structvss_1_1simulation_1_1_deploy_node.xhtml#details)
struct [DisplayInformation](structvss_1_1simulation_1_1_display_information.xhtml) Defines the display settings of a camera sensor. [More...](structvss_1_1simulation_1_1_display_information.xhtml#details)
struct [EndPointRange](structvss_1_1simulation_1_1_end_point_range.xhtml) Describes the parameters used to configure AVX deployment. [More...](structvss_1_1simulation_1_1_end_point_range.xhtml#details)
struct [EnvironmentUpdate](structvss_1_1simulation_1_1_environment_update.xhtml) Applies an update to the environment. [More...](structvss_1_1simulation_1_1_environment_update.xhtml#details)
struct [GpuIdentifier](structvss_1_1simulation_1_1_gpu_identifier.xhtml) Represents an identifier for a GPU. [More...](structvss_1_1simulation_1_1_gpu_identifier.xhtml#details)
struct [Grid](structvss_1_1simulation_1_1_grid.xhtml) Describes the type of lidar sensor grid. [More...](structvss_1_1simulation_1_1_grid.xhtml#details)
struct [KinematicProperties](structvss_1_1simulation_1_1_kinematic_properties.xhtml) Properties that define the motion of a solid. [More...](structvss_1_1simulation_1_1_kinematic_properties.xhtml#details)
struct [LidarSimulation](structvss_1_1simulation_1_1_lidar_simulation.xhtml) Describes simulation parameters for a lidar. [More...](structvss_1_1simulation_1_1_lidar_simulation.xhtml#details)
struct [LightingSystem](structvss_1_1simulation_1_1_lighting_system.xhtml) Describes a lighting system with its identifier and either a data buffer or the identifier of the uploaded resource. [More...](structvss_1_1simulation_1_1_lighting_system.xhtml#details)
struct [LightingSystemConfiguration](structvss_1_1simulation_1_1_lighting_system_configuration.xhtml) struct [LightingSystemParameters](structvss_1_1simulation_1_1_lighting_system_parameters.xhtml) Contains lighting system simulation parameters. [More...](structvss_1_1simulation_1_1_lighting_system_parameters.xhtml#details)
struct [LocalNodes](structvss_1_1simulation_1_1_local_nodes.xhtml) The deploy parameters of the local workstation. [More...](structvss_1_1simulation_1_1_local_nodes.xhtml#details)
struct [ManualBatching](structvss_1_1simulation_1_1_manual_batching.xhtml) Defines the manual batching configuration. [More...](structvss_1_1simulation_1_1_manual_batching.xhtml#details)
struct [ObjectKey](structvss_1_1simulation_1_1_object_key.xhtml) Object key used to identify the nodes on which the update shall be applied. [More...](structvss_1_1simulation_1_1_object_key.xhtml#details)
struct [ObjectUpdate](structvss_1_1simulation_1_1_object_update.xhtml) Update to be applied on an object. [More...](structvss_1_1simulation_1_1_object_update.xhtml#details)
struct [OutputSplitting](structvss_1_1simulation_1_1_output_splitting.xhtml) Defines the output data splitting configuration. [More...](structvss_1_1simulation_1_1_output_splitting.xhtml#details)
struct [PbCameraSimulation](structvss_1_1simulation_1_1_pb_camera_simulation.xhtml) Describes the simulation parameters for a physics-based camera. [More...](structvss_1_1simulation_1_1_pb_camera_simulation.xhtml#details)
struct [PolarGrid](structvss_1_1simulation_1_1_polar_grid.xhtml) Defines the polar grid. [More...](structvss_1_1simulation_1_1_polar_grid.xhtml#details)
struct [RadarDebugViewParameters](structvss_1_1simulation_1_1_radar_debug_view_parameters.xhtml) Describes the parameters for the radar's debug view. [More...](structvss_1_1simulation_1_1_radar_debug_view_parameters.xhtml#details)
struct [RadarGridSampling](structvss_1_1simulation_1_1_radar_grid_sampling.xhtml) Radar grid sampling specifies the global sampling and the adaptive sampling to be applied to the scene. [More...](structvss_1_1simulation_1_1_radar_grid_sampling.xhtml#details)
struct [RadarGridSamplingParameters](structvss_1_1simulation_1_1_radar_grid_sampling_parameters.xhtml) Radar grid sampling parameters, which consist of the ray spacing parameter. [More...](structvss_1_1simulation_1_1_radar_grid_sampling_parameters.xhtml#details)
struct [RadarOutputSplitting](structvss_1_1simulation_1_1_radar_output_splitting.xhtml) Defines the radar output data splitting configuration. [More...](structvss_1_1simulation_1_1_radar_output_splitting.xhtml#details)
struct [RadarSimulation](structvss_1_1simulation_1_1_radar_simulation.xhtml) Describes the simulation parameters for a radar and, optionally, the type of batching method. [More...](structvss_1_1simulation_1_1_radar_simulation.xhtml#details)
struct [RecordingFormat](structvss_1_1simulation_1_1_recording_format.xhtml) Defines the format for recording the sensor's outputs. [More...](structvss_1_1simulation_1_1_recording_format.xhtml#details)
struct [RemoteDirectMemoryAccess](structvss_1_1simulation_1_1_remote_direct_memory_access.xhtml) Data access using Remote Direct Memory Access (RDMA) technology is delivered as a beta feature in the current release. [More...](structvss_1_1simulation_1_1_remote_direct_memory_access.xhtml#details)
struct [RenderingParameters](structvss_1_1simulation_1_1_rendering_parameters.xhtml) Sets the rendering engine parameters for a camera. [More...](structvss_1_1simulation_1_1_rendering_parameters.xhtml#details)
class [ResourceUploader](classvss_1_1simulation_1_1_resource_uploader.xhtml) Upload Service. [More...](classvss_1_1simulation_1_1_resource_uploader.xhtml#details)
struct [RxBatching](structvss_1_1simulation_1_1_rx_batching.xhtml) Sets the batching on rx channels. [More...](structvss_1_1simulation_1_1_rx_batching.xhtml#details)
struct [SceneInfo](structvss_1_1simulation_1_1_scene_info.xhtml) Contains all components that make up a scene: the assets and the track. [More...](structvss_1_1simulation_1_1_scene_info.xhtml#details)
struct [SensorConfig](structvss_1_1simulation_1_1_sensor_config.xhtml) Describes a binary sensor configuration data. [More...](structvss_1_1simulation_1_1_sensor_config.xhtml#details)
struct [SensorParameters](structvss_1_1simulation_1_1_sensor_parameters.xhtml) Contains the simulation parameters for a given sensor id. [More...](structvss_1_1simulation_1_1_sensor_parameters.xhtml#details)
class [Simulation](classvss_1_1simulation_1_1_simulation.xhtml) This service provides the simulation control procedures. [More...](classvss_1_1simulation_1_1_simulation.xhtml#details)
struct [SimulationParameters](structvss_1_1simulation_1_1_simulation_parameters.xhtml) Contains general simulation parameters, as well as 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...](structvss_1_1simulation_1_1_simulation_parameters.xhtml#details)
struct [State](structvss_1_1simulation_1_1_state.xhtml) [State](structvss_1_1simulation_1_1_state.xhtml "State defined on an object node.") defined on an object node. [More...](structvss_1_1simulation_1_1_state.xhtml#details)
struct [Tag](structvss_1_1simulation_1_1_tag.xhtml) Definition of the tag using or not an index. [More...](structvss_1_1simulation_1_1_tag.xhtml#details)
struct [ThermalCameraSimulation](structvss_1_1simulation_1_1_thermal_camera_simulation.xhtml) Describes the simulation parameters for a thermal camera. [More...](structvss_1_1simulation_1_1_thermal_camera_simulation.xhtml#details)
struct [TopLeftCornerPosition](structvss_1_1simulation_1_1_top_left_corner_position.xhtml) Describes the top left corner position of the rendering window relative to the top left corner of the monitor. [More...](structvss_1_1simulation_1_1_top_left_corner_position.xhtml#details)
struct [UploadMetaData](structvss_1_1simulation_1_1_upload_meta_data.xhtml) Provides information on the data to upload. [More...](structvss_1_1simulation_1_1_upload_meta_data.xhtml#details)
struct [UploadRequest](structvss_1_1simulation_1_1_upload_request.xhtml) Upload request message. [More...](structvss_1_1simulation_1_1_upload_request.xhtml#details)
struct [WorldUpdate](structvss_1_1simulation_1_1_world_update.xhtml) Contains an update of the world to be applied to AVX. [More...](structvss_1_1simulation_1_1_world_update.xhtml#details)
## Enumerations
enum [Qualities](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684) {
[UNDEFINED](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684ad1ae31a31c309c8a363806cd8ab3d6f3) = 0, [LOW](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684ae6fc8fb6ed8eeaf4fa38aedf1669381a) = 1, [MEDIUM](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684a86c5a83b8fa0d4d0a4a12c8cd6259605) = 2, [HIGH](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684abf278ae214602475245405172522b579) = 3,
[EXTREME](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684a83a8efef6ebe18c4f9519626866298b6) = 4
} The possible values for quality factors. [More...](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684)
enum [ColorMode](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404) { [BLACKWHITE](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404acf5a02e5f0bc8bdbf3b74c0728fe726e) = 0, [COATING](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404a9b8afaa5fbc5195ce7cd9becb99ab9d5) = 1, [VELOCITY](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404aa06e6d855d55e6bd80674ec291c1ba67) = 2, [NORMAL](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404af90529c5947b6f5243ca13f7bc0465cd) = 3 } The available color modes for the radar's debug view output. [More...](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404)
enum [RadarOutputSplittingLevel](namespacevss_1_1simulation.xhtml#a9f79257d8ddad118e85eec0df5db95fb) { [DEFAULT](namespacevss_1_1simulation.xhtml#a9f79257d8ddad118e85eec0df5db95fbaa6b85131903662cbfa97b6f799dd680a) = 0, [MODE](namespacevss_1_1simulation.xhtml#a9f79257d8ddad118e85eec0df5db95fba026225496cf2e8a6d5306785e2e16d8e) = 1, [TRANSMITTER](namespacevss_1_1simulation.xhtml#a9f79257d8ddad118e85eec0df5db95fba3182fd6094102e312f49f4b9dc469740) = 2 } The radar output splitting level. [More...](namespacevss_1_1simulation.xhtml#a9f79257d8ddad118e85eec0df5db95fb)
## Variables
import avx vss simulation deploy\_parameters [proto](namespacevss_1_1simulation.xhtml#a22592b5fe4265e80d3c84c69ff6c83ad)## Enumeration Type Documentation
## [◆ ](#abc43242d8d08dbce62bef12528367684)Qualities
enum [vss::simulation::Qualities](namespacevss_1_1simulation.xhtml#abc43242d8d08dbce62bef12528367684)
The possible values for quality factors.
EnumeratorUNDEFINED Undefined value. (The default value will apply.)
LOW Low quality.
MEDIUM Medium quality.
HIGH High quality.
EXTREME Extreme quality. (Default value.)
## [◆ ](#ab9c0b1a15c582953407b339e28132404)ColorMode
enum [vss::simulation::ColorMode](namespacevss_1_1simulation.xhtml#ab9c0b1a15c582953407b339e28132404)
The available color modes for the radar's debug view output.
EnumeratorBLACKWHITE Color in shades of gray by the angle of incidence between the surface and viewing direction. (Default value.)
COATING Color by the dielectric properties of the materials.
NoteColor assignment is determined by the material indices of each radar simulation instance and is not deterministic.Optionally shaded (when enable\_material\_shading is set to true in [RadarDebugViewParameters](structvss_1_1simulation_1_1_radar_debug_view_parameters.xhtml "Describes the parameters for the radar's debug view.")).
VELOCITY Color by the relative velocities.
The R, G and B values correspond respectively to the velocities in the X, Y and Z direction.
NORMAL Color by the normal of the surfaces converted to RGB.
## [◆ ](#a9f79257d8ddad118e85eec0df5db95fb)RadarOutputSplittingLevel
enum [vss::simulation::RadarOutputSplittingLevel](namespacevss_1_1simulation.xhtml#a9f79257d8ddad118e85eec0df5db95fb)
The radar output splitting level.
EnumeratorDEFAULT Default value. Output data is not split.
MODE Split by radar mode.
TRANSMITTER Split by transmitter.
## Variable Documentation
## [◆ ](#a22592b5fe4265e80d3c84c69ff6c83ad)proto
import google protobuf wrappers vss::simulation::proto