ROS2::LidarRegistrarRequests Class Reference

Interface class that allows for communication with the LidarRegistrarSystemComponent. More...

#include <LidarRegistrarBus.h>

Public Member Functions
	AZ_RTTI (LidarRegistrarRequests, "{22030dc7-a1db-43bd-b748-0fb9ec43ce2e}")
virtual void	RegisterLidarSystem (const char *name, const char *description, const LidarSystemFeatures &features)=0
virtual AZStd::vector< AZStd::string >	GetRegisteredLidarSystems () const =0
virtual const LidarSystemMetaData *	GetLidarSystemMetaData (const AZStd::string &name) const =0

Detailed Description

Interface class that allows for communication with the LidarRegistrarSystemComponent.

Member Function Documentation

GetLidarSystemMetaData()

virtual const LidarSystemMetaData * ROS2::LidarRegistrarRequests::GetLidarSystemMetaData ( const AZStd::string &  name ) const

pure virtual

Returns metadata of a registered lidar system. If no lidar system with provided name was found returns nullptr.

Parameters

name	Name of a registered lidar system.

Returns

Pointer to the metadata of a lidar system with the provided name.

GetRegisteredLidarSystems()

virtual AZStd::vector< AZStd::string > ROS2::LidarRegistrarRequests::GetRegisteredLidarSystems ( ) const

pure virtual

Returns A list of all registered lidar systems.

Returns

A vector of registered lidar systems' names.

RegisterLidarSystem()

virtual void ROS2::LidarRegistrarRequests::RegisterLidarSystem ( const char *  name, const char *  description, const LidarSystemFeatures &  features  )

pure virtual

Registers a new lidar system under the provided name. To obtain the busId of a lidarSystem use the AZ_CRC macro as follows.

AZ::Crc32 busId = AZ_CRC(<lidarSystemName>);

Parameters

name	Name of the newly registered lidar system.
description	Further information about the lidar system.

---

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

• Gems/ROS2/Code/Include/ROS2/Lidar/LidarRegistrarBus.h