#include <SDFormatSensorImporterHook.h>

Public Types
using	ErrorString = AZStd::string

using	ConvertSensorOutcome = AZ::Outcome< void, AZStd::string >

using	ConvertSDFSensorCallback = AZStd::function< ConvertSensorOutcome(AZ::Entity &, const sdf::Sensor &)>

Public Member Functions
	AZ_TYPE_INFO (SensorImporterHook, "{23f189e3-8da4-4498-9b89-1ef6c900940a}")

Public Attributes
AZStd::unordered_set< sdf::SensorType >	m_sensorTypes

AZStd::unordered_set< AZStd::string >	m_supportedSensorParams
	Names of the sensor's parameters in SDFormat description that are supported by the particular O3DE component.

AZStd::unordered_set< AZStd::string >	m_pluginNames

AZStd::unordered_set< AZStd::string >	m_supportedPluginParams

ConvertSDFSensorCallback	m_sdfSensorToComponentCallback

Detailed Description

Hook used in ROS2 Gem Robot Importer to create ROS2 sensor components based on SDFormat model description. It implements the parameters mapping between the SDFormat sensor and the particular O3DE component. It should be registered as a serialization attribute in the component's reflection to make the it visible in the SDFormat model parser. See the sensor element at http://sdformat.org/spec?ver=1.10&elem=sensor for more details on SDFormat.

Member Typedef Documentation

◆ ErrorString

using ROS2::SDFormat::SensorImporterHook::ErrorString = AZStd::string

Registered function that is invoked when a sensor of the specified type is processed by the SDFormat Importer.

Parameters

AZ::Entity&	a reference to the Entity in which one or more O3DE component is created by the importer
sdf::Sensor&	a reference to the sensor data in SDFormat, which is used to configure O3DE component

Member Data Documentation

◆ m_pluginNames

AZStd::unordered_set<AZStd::string> ROS2::SDFormat::SensorImporterHook::m_pluginNames

Names of plugins associated with the sensor in SDFormat description that are supported by the particular O3DE component. Multiple SDFormat plugins can map to one O3DE component.

◆ m_sensorTypes

AZStd::unordered_set<sdf::SensorType> ROS2::SDFormat::SensorImporterHook::m_sensorTypes

Types of sensors in SDFormat description that can be mapped to the particular O3DE component. Multiple SDFormat sensors can map to one O3DE component.

◆ m_supportedPluginParams

AZStd::unordered_set<AZStd::string> ROS2::SDFormat::SensorImporterHook::m_supportedPluginParams

Names of the plugin's parameters associated with the sensor in SDFormat description that are supported by the particular O3DE component.

The documentation for this struct was generated from the following file:

Gems/ROS2/Code/Include/ROS2/RobotImporter/SDFormatSensorImporterHook.h

Public Types

Public Member Functions