## On this page

  

 

 # Class simulation\_framework::avx\_sensor\_cosim::AvxVssApiAdapter

 Last update: 22.04.2026 

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `co_sim/avx_sensor/avx_vss_api_adapter/avx_vss_api_adapter.h` (line 35)

AVX VSS API Adapter.

This class is used to interact with AVX VSS API. Provides a simple interface, with status check and configurable timeout mechanism, to load, initialize, update, stop, unload, and kill one targeted AVX Sensor service.

## Members

- [AvxVssApiAdapter](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a59b09da2ec12532a4342551366aab665)
- [DeserializeSensorDataDescriptions](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a353382be749e0909337e395af828bc61)
- [GetGrpcChannel](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ac6002b11a6411cc69cb456a4340aada3)
- [GetLatestSensorDataDescriptions](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1aeb52b2acbff9db3edcd4a33d8ba9211c)
- [GetSensorIdentifiers](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ac5a21c59e7e440e46a0bbbf88ece7a54)
- [Initialize](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a91a12968c3e9a3f1e7601124347dc424)
- [IsAllSensorDataDescriptionsAvailable](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ad34f7a9ef15162b7cc5ed2d4e09db83f)
- [IsRequestSuccessful](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1af0c66b6549fea0cbc7a6f46c4e04ac07)
- [Kill](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1aef5736c8514738119b66dfdb70015314)
- [Load](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a65b1764c35521d1454692fd3459c6f37)
- [Load](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ab9ba91ec020160a02458f373f6847d09)
- [ReadSensorDataDescription](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a0620b9bd54dd8ce55579536b17133dc9)
- [SensorDataDescriptions](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a912b41e7bc7520b5321f8eedfa36dd07)
- [SerializeSensorDataDescriptions](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a70012a5e06c4ba2f1292029f664e3fb8)
- [SetSensorIdentifiers](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1af1a11124e5274c64568d294ee629b68f)
- [Stop](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a8bec37d202019eb3dc86ccbefa0b75a1)
- [Unload](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1af3fdcb93ae044c647df4e63ea9156571)
- [Update](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1aeaf57c2d395c56a8141c4e3daf37b826)
- [Update](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a444e4091516e63dcab3e627cbfe79968)
- [WaitForConnection](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a607bd314f3c7972927a14ec1b1952960)
- [~AvxVssApiAdapter](classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter.md#classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a0c49dcc2c769f8859994306149e0b92e)

## Public types

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a912b41e7bc7520b5321f8eedfa36dd07"></a>

### Typedef SensorDataDescriptions

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `co_sim/avx_sensor/avx_vss_api_adapter/avx_vss_api_adapter.h` (line 38)

```cpp
using simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::SensorDataDescriptions =  std::vector<ansys::api::avxcelerate::sensors::v1::data_access::SensorDataDescription>

```

**Return type**: std::vector&lt; ansys::api::avxcelerate::sensors::v1::data\_access::SensorDataDescription &gt;

## Public functions

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a59b09da2ec12532a4342551366aab665"></a>

### Function AvxVssApiAdapter

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::AvxVssApiAdapter(const std::string &grpc_endpoint, ApiVariant api_variant=ApiVariant::kUpdateByWorldUpdate, const TransportModeConfig &transport_config=TransportModeConfig{})

```

Constructor.

**Parameters**:

- **grpc\_endpoint**: The grpc endpoint of the AVX Sensor service (host:port for TCP, ignored for UDS)
- **api\_variant**: Select which VSS API to use (default: sensors/v1)
- **transport\_config**: Transport mode configuration (default: Insecure mode for backwards compatibility)

**Parameters**:

- const std::string &amp; **grpc\_endpoint**
- ApiVariant **api\_variant** = ApiVariant::kUpdateByWorldUpdate
- const TransportModeConfig &amp; **transport\_config** = TransportModeConfig{}

**Return type**:

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a0c49dcc2c769f8859994306149e0b92e"></a>

### Function ~AvxVssApiAdapter

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::~AvxVssApiAdapter()

```

Destructor.

**Return type**:

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a65b1764c35521d1454692fd3459c6f37"></a>

### Function Load

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Load(const ansys::api::avxcelerate::sensors::osi::v1::simulation::Configuration &configuration, const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(30))

```

Load the simulation configuration for OSI API.

Loads AVX using Configuration containing a track, a list of assets, some simulation parameters, a sensor configuration, a lighting system (optional), some deployment parameters, and some simulation control parameters.

**Parameters**:

- **configuration**: The VSS simulation configuration
- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the load request was successful, false otherwise

**Parameters**:

- const ansys::api::avxcelerate::sensors::osi::v1::simulation::Configuration &amp; **configuration**
- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(30)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ab9ba91ec020160a02458f373f6847d09"></a>

### Function Load

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Load(const ansys::api::avxcelerate::sensors::v1::simulation::Configuration &configuration, const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(30))

```

Load the simulation configuration for Sensors v1 API.

Loads AVX using Configuration containing a track, a list of assets, some simulation parameters, a sensor configuration, a lighting system (optional), some deployment parameters, and some simulation control parameters.

**Parameters**:

- **configuration**: The VSS simulation configuration
- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the load request was successful, false otherwise

**Parameters**:

- const ansys::api::avxcelerate::sensors::v1::simulation::Configuration &amp; **configuration**
- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(30)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1aeaf57c2d395c56a8141c4e3daf37b826"></a>

### Function Update

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Update(const osi3::GroundTruth &ground_truth, const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(5))

```

Update the simulation.

**Parameters**:

- **ground\_truth**: The OSI GroundTruth
- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the update request was successful, false otherwise

**Parameters**:

- const osi3::GroundTruth &amp; **ground\_truth**
- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(5)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a444e4091516e63dcab3e627cbfe79968"></a>

### Function Update

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Update(const ansys::api::avxcelerate::sensors::v1::simulation::WorldUpdate &world_update, const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(5))

```

Update overload for sensors/v1 API.

**Parameters**:

- **world\_update**: The Sensors v1 WorldUpdate
- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the update request was successful, false otherwise

**Parameters**:

- const ansys::api::avxcelerate::sensors::v1::simulation::WorldUpdate &amp; **world\_update**
- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(5)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a91a12968c3e9a3f1e7601124347dc424"></a>

### Function Initialize

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Initialize(const ansys::api::avxcelerate::sensors::v1::simulation::WorldUpdate &world_update, const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(5))

```

Initialize overload for sensors/v1 API.

**Parameters**:

- **world\_update**: The Sensors v1 WorldUpdate (initial state)
- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the initialize request was successful, false otherwise

**Parameters**:

- const ansys::api::avxcelerate::sensors::v1::simulation::WorldUpdate &amp; **world\_update**
- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(5)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a8bec37d202019eb3dc86ccbefa0b75a1"></a>

### Function Stop

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Stop(const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(5))

```

Stop (Reset) the simulation.

Applies a world model update to AVX.

**Parameters**:

- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the stop request was successful, false otherwise

**Parameters**:

- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(5)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1af3fdcb93ae044c647df4e63ea9156571"></a>

### Function Unload

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Unload(const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(5))

```

Unload the simulation.

Unloads the simulation and switches AVX back to STARTED state. This command is used to restart a simulation without having to restart AVX.

**Parameters**:

- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the unload request was successful, false otherwise

**Parameters**:

- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(5)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1aef5736c8514738119b66dfdb70015314"></a>

### Function Kill

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
bool simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::Kill(const std::chrono::seconds &timeout_in_seconds=std::chrono::seconds(5))

```

Kill the simulation.

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

**Parameters**:

- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

True if the kill request was successful, false otherwise

**Parameters**:

- const std::chrono::seconds &amp; **timeout\_in\_seconds** = std::chrono::seconds(5)

**Return type**: bool

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1aeb52b2acbff9db3edcd4a33d8ba9211c"></a>

### Function GetLatestSensorDataDescriptions

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
SensorDataDescriptions simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::GetLatestSensorDataDescriptions(const std::chrono::milliseconds &timeout_in_milliseconds=std::chrono::milliseconds(1000))

```

Get the latest sensor data descriptions in a vector.

This function will wait for all sensor data descriptions to be available and return them in a vector. If the sensor data descriptions are not available, the function will wait for them to be available.

**Parameters**:

- **timeout\_in\_seconds**: The timeout in seconds

**Returns**:

A vector of Sensor data descriptions

**Parameters**:

- const std::chrono::milliseconds &amp; **timeout\_in\_milliseconds** = std::chrono::milliseconds(1000)

**Return type**: SensorDataDescriptions

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ac5a21c59e7e440e46a0bbbf88ece7a54"></a>

### Function GetSensorIdentifiers

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
const std::vector< std::string > & simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::GetSensorIdentifiers() const

```

Get the sensor identifiers.

**Returns**:

A vector of sensor identifiers

**Return type**: const std::vector&lt; std::string &gt; &amp;

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1af1a11124e5274c64568d294ee629b68f"></a>

### Function SetSensorIdentifiers

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::SetSensorIdentifiers(const ansys::api::avxcelerate::sensors::v1::simulation::SimulationParameters &simulation_parameters)

```

Set the sensor identifiers.

**Parameters**:

- **simulation\_parameters**: The simulation parameters

**Parameters**:

- const ansys::api::avxcelerate::sensors::v1::simulation::SimulationParameters &amp; **simulation\_parameters**

**Return type**: void

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1ac6002b11a6411cc69cb456a4340aada3"></a>

### Function GetGrpcChannel

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::shared_ptr< grpc::Channel > simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::GetGrpcChannel() const

```

Get the gRPC channel.

**Returns**:

Shared pointer to the gRPC channel

**Return type**: std::shared\_ptr&lt; grpc::Channel &gt;

## Public static functions

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a70012a5e06c4ba2f1292029f664e3fb8"></a>

### Function SerializeSensorDataDescriptions

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

```cpp
static std::vector< unsigned char > simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::SerializeSensorDataDescriptions(const SensorDataDescriptions &sensor_data_descriptions)

```

Serialize SensorDataDescriptions to bytes array.

Converts a vector of SensorDataDescription objects into a bytes array for transmission. This function can be used to prepare data for rtidds::GenericBytesMessage.

**Parameters**:

- **sensor\_data\_descriptions**: The sensor data descriptions to serialize

**Returns**:

A vector of unsigned char containing the serialized data

**Parameters**:

- const SensorDataDescriptions &amp; **sensor\_data\_descriptions**

**Return type**: std::vector&lt; unsigned char &gt;

<a id="classsimulation__framework_1_1avx__sensor__cosim_1_1AvxVssApiAdapter_1a353382be749e0909337e395af828bc61"></a>

### Function DeserializeSensorDataDescriptions

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

```cpp
static SensorDataDescriptions simulation_framework::avx_sensor_cosim::AvxVssApiAdapter::DeserializeSensorDataDescriptions(const std::vector< unsigned char > &bytes_array)

```

Deserialize bytes array to SensorDataDescriptions.

Converts a bytes array back into a vector of SensorDataDescription objects. This function can be used to reconstruct data received from rtidds::GenericBytesMessage.

**Parameters**:

- **bytes\_array**: The bytes array containing the serialized data

**Returns**:

A vector of SensorDataDescription objects

**Exceptions**:

- **std::runtime\_error**: if deserialization fails

**Parameters**:

- const std::vector&lt; unsigned char &gt; &amp; **bytes\_array**

**Return type**: SensorDataDescriptions