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.
ROS2::ROS2Lidar2DSensorComponent Class Reference

#include <ROS2Lidar2DSensorComponent.h>

Inherits ROS2::ROS2SensorComponentBase< TickBasedSource >.

Public Member Functions

 AZ_COMPONENT (ROS2Lidar2DSensorComponent, "{F4C2D970-1D69-40F2-9D4D-B52DCFDD2704}", SensorBaseType)
 
 ROS2Lidar2DSensorComponent (const SensorConfiguration &sensorConfiguration, const LidarSensorConfiguration &lidarConfiguration)
 
void Activate () override
 
void Deactivate () override
 
- Public Member Functions inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
 AZ_COMPONENT_DECL ((ROS2SensorComponentBase, AZ_CLASS))
 
void Activate () override
 
void Deactivate () override
 

Static Public Member Functions

static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
static void Reflect (AZ::ReflectContext *context)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 

Additional Inherited Members

- Public Types inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
using SensorBaseType = ROS2SensorComponentBase< TickBasedSource >
 
- Protected Member Functions inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
void StartSensor (float sensorFrequency, typename EventSourceT::AdaptedCallbackType adaptedCallback, typename EventSourceT::SourceCallbackType sourceCallback=nullptr)
 
void StopSensor ()
 Stops sensor and disconnects event callbacks passed through RSO2::ROS2SensorComponentBase::StartSensor.
 
AZStd::string GetNamespace () const
 Returns a complete namespace for this sensor topics and frame ids.
 
AZStd::string GetFrameID () const
 Returns this sensor frame ID. The ID contains namespace.
 
- Protected Attributes inherited from ROS2::ROS2SensorComponentBase< TickBasedSource >
SensorConfiguration m_sensorConfiguration
 Basic sensor configuration.
 
EventSourceAdapter< TickBasedSourcem_eventSourceAdapter
 Adapter for selected event source (see this class documentation).
 
EventSourceT::SourceEventHandlerType m_sourceEventHandler
 Handler for source event. Requires manual assignment and connecting to source event in derived class.
 
EventSourceT::AdaptedEventHandlerType m_adaptedEventHandler
 Handler for adapted event. Requires manual assignment and connecting to adapted event in derived class.
 

Detailed Description

Lidar 2D sensor Component. Lidars (Light Detection and Ranging) emit laser light and measure it after reflection. Lidar Component allows customization of lidar type and behavior and encapsulates both simulation and data publishing. It requires ROS2FrameComponent.


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