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

Interface that allows to get sensor configuration and switch publish state. More...

#include <SensorConfigurationRequestBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityComponentIdPair
 

Public Member Functions

 AZ_RTTI (SensorConfigurationRequest, "{01904eab-fa33-7487-b634-e3f8361eb5fb}")
 
virtual SensorConfiguration GetSensorConfiguration () const =0
 Get the configuration of the sensor.
 
virtual void SetSensorEnabled (bool enable)=0
 Enable or disable the sensor, completely stopping the sensor from running.
 
virtual void SetPublishingEnabled (bool publishingEnabled)=0
 
virtual void SetVisualizeEnabled (bool visualizeEnabled)=0
 
virtual float GetEffectiveFrequency () const =0
 Get the the current frequency of the sensor in hertz.
 
virtual void SetDesiredFrequency (float frequency)=0
 Sets desired frequency of the sensor in hertz.
 

Static Public Attributes

static constexpr AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Interface that allows to get sensor configuration and switch publish state.

Member Function Documentation

◆ SetPublishingEnabled()

virtual void ROS2::SensorConfigurationRequest::SetPublishingEnabled ( bool publishingEnabled)
pure virtual

Enable or disable publishing of the sensor to ROS 2. The sensor implementation will still be running, but the data will not be published.

◆ SetVisualizeEnabled()

virtual void ROS2::SensorConfigurationRequest::SetVisualizeEnabled ( bool visualizeEnabled)
pure virtual

Enable or disable visualization of the sensor. The sensor implementation will still be running, but the data will not be visualized in the viewport.

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