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::ROS2Names Namespace Reference

Utility class for handling ROS2 naming rules. More...

Functions

AZStd::string GetNamespacedName (const AZStd::string &ns, const AZStd::string &name)
 Joins namespace and the given name.
 
AZStd::string RosifyName (const AZStd::string &input)
 
AZ::Outcome< void, AZStd::string > ValidateNamespace (const AZStd::string &ros2Namespace)
 Validate namespace adherence to ROS2 specification. Delegates validation to ROS2 layers.
 
AZ::Outcome< void, AZStd::string > ValidateNamespaceField (void *newValue, const AZ::Uuid &valueType)
 Validate namespace field. Fits ChangeValidate for Editor fields.
 
AZ::Outcome< void, AZStd::string > ValidateTopic (const AZStd::string &topic)
 Validate topic adherence to ROS2 specification.
 
AZ::Outcome< void, AZStd::string > ValidateTopicField (void *newValue, const AZ::Uuid &valueType)
 Validate topic field. Fits ChangeValidate for Editor fields.
 

Detailed Description

Utility class for handling ROS2 naming rules.

Function Documentation

◆ RosifyName()

AZStd::string ROS2::ROS2Names::RosifyName ( const AZStd::string &  input)

Converts input to a ROS2-acceptable name for topics and namespaces. Any characters not fitting ROS2 naming specification are replaced with underscores.