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::ROS2WheelOdometryComponent Class Reference

#include <ROS2WheelOdometry.h>

Inherits ROS2::ROS2SensorComponentBase< PhysicsBasedSource >.

Public Member Functions

 AZ_COMPONENT (ROS2WheelOdometryComponent, "{9bdb8c23-ac76-4c25-8d35-37aaa9f43fac}", SensorBaseType)
 
void Activate () override
 
void Deactivate () override
 
- Public Member Functions inherited from ROS2::ROS2SensorComponentBase< PhysicsBasedSource >
 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< PhysicsBasedSource >
static void Reflect (AZ::ReflectContext *context)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 

Additional Inherited Members

- Public Types inherited from ROS2::ROS2SensorComponentBase< PhysicsBasedSource >
using SensorBaseType = ROS2SensorComponentBase< PhysicsBasedSource >
 
- Protected Member Functions inherited from ROS2::ROS2SensorComponentBase< PhysicsBasedSource >
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< PhysicsBasedSource >
SensorConfiguration m_sensorConfiguration
 Basic sensor configuration.
 
EventSourceAdapter< PhysicsBasedSourcem_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

Wheel odometry sensor component. It constructs and publishes an odometry message, which contains information about the vehicle's velocity and position in space. This is a physical sensor that takes a vehicle's configuration and computes updates from the wheels' rotations.

See also
nav_msgs package.

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