Open 3D Engine ROS2 Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ROS2::SensorConfiguration Struct Reference

#include <SensorConfiguration.h>

Public Member Functions

 AZ_TYPE_INFO (SensorConfiguration, "{4755363D-0B5A-42D7-BBEF-152D87BA10D7}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

AZStd::map< AZStd::string, TopicConfiguration > m_publishersConfigurations
 
float m_frequency = 10.f
 
bool m_publishingEnabled = true
 Determines whether the sensor is publishing (sending data to ROS 2 ecosystem).
 
bool m_visualize = true
 Determines whether the sensor is visualized in O3DE (for example, point cloud is drawn for LIDAR).
 

Detailed Description

General configuration for sensors. All sensors can be set to a certain frequency, have their data published or not, and visualized or not.

Member Data Documentation

◆ m_frequency

float ROS2::SensorConfiguration::m_frequency = 10.f

Frequency in Hz (1/s). Applies both to data acquisition and publishing.

◆ m_publishersConfigurations

AZStd::map<AZStd::string, TopicConfiguration> ROS2::SensorConfiguration::m_publishersConfigurations

ROS2 Publishers of this sensor. Some sensors can have more than one publisher (example: Camera).

Note
This map will typically hold 1-3 elements.
The documentation for this struct was generated from the following file: