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.
Public Member Functions | Protected Member Functions | List of all members
ROS2::ControlSubscriptionHandler< T > Class Template Referenceabstract

#include <ControlSubscriptionHandler.h>

Inherits ROS2::IControlSubscriptionHandler.

Public Member Functions

void Activate (const AZ::Entity *entity, const TopicConfiguration &subscriberConfiguration) override final
 
void Deactivate () override final
 Interface handling component deactivation.
 
virtual void Activate (const AZ::Entity *entity, const TopicConfiguration &subscriberConfiguration)=0
 
virtual void Deactivate ()=0
 Interface handling component deactivation.
 

Protected Member Functions

AZ::EntityId GetEntityId () const
 

Detailed Description

template<typename T>
class ROS2::ControlSubscriptionHandler< T >

The generic class for handling subscriptions to ROS2 control messages of different types.

See also
ControlConfiguration::Steering.

Member Function Documentation

◆ Activate()

template<typename T >
void ROS2::ControlSubscriptionHandler< T >::Activate ( const AZ::Entity *  entity,
const TopicConfiguration &  subscriberConfiguration 
)
inlinefinaloverridevirtual

Interface handling component activation Only activated IComponentActivationHandler will receive and process control messages.

Parameters
entityActivation context for the owning Component - the entity it belongs to.
subscriberConfigurationconfiguration with topic and qos

Implements ROS2::IControlSubscriptionHandler.

◆ Deactivate()

template<typename T >
void ROS2::ControlSubscriptionHandler< T >::Deactivate ( )
inlinefinaloverridevirtual

Interface handling component deactivation.

Implements ROS2::IControlSubscriptionHandler.

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