ROS2::NamespaceConfiguration Struct Reference

#include <NamespaceConfiguration.h>

Public Types
enum class	NamespaceStrategy { Default , Empty , FromEntityName , Custom }

Public Member Functions
	AZ_TYPE_INFO (NamespaceConfiguration, NamespaceConfigurationTypeId)

Static Public Member Functions
static void	Reflect (AZ::ReflectContext *context)

Public Attributes
AZStd::string	m_customNamespace = ""
	Custom namespace that can be set by the user.
NamespaceStrategy	m_namespaceStrategy = NamespaceStrategy::Default

Detailed Description

Configuration for handling of namespaces. Namespaces are useful for various ROS2 components. This structure encapsulates the namespace itself, composing namespaces and context-dependent default values.

Note

This structure is handled through ROS2FrameComponent.

Member Enumeration Documentation

NamespaceStrategy

enum class ROS2::NamespaceConfiguration::NamespaceStrategy

strong

A choice of methods to handle namespaces.

Note

Top level ROS2FrameComponent will likely be associated with an interesting object (robot). For multi-robot simulations, namespaces are often derived from the robot name itself. For this reason, the default behavior for top level ROS2FrameComponent is to generate the namespace from entity name.

Enumerator
Default	FromEntityName for top-level frames, Empty otherwise.
Empty	An empty, blank namespace.
FromEntityName	Generate from Entity name, but substitute disallowed characters through RosifyName.
Custom	Non-empty and based on user-provided value.

---

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

• Gems/ROS2/Code/Include/ROS2/Frame/NamespaceConfiguration.h