Base class for plugin implementations with lifecycle node integration. More...

#include <PluginBase.hpp>

Inheritance diagram for roboligo::PluginBase:

[legend]

Public Member Functions
std::shared_ptr< rclcpp_lifecycle::LifecycleNode >	get_node () const
	Retrieves the parent lifecycle node.
const std::string &	get_plugin_name () const
	Retrieves the plugin name.
virtual void	initialize (const std::shared_ptr< rclcpp_lifecycle::LifecycleNode > parent_node, const std::string &plugin_name)
	Initializes the plugin with a parent lifecycle node and plugin name.
virtual void	on_initialize ()
	Called during plugin initialization. Override in derived classes for custom setup.
	PluginBase ()=default
	Default constructor.
virtual	~PluginBase ()=default
	Virtual destructor for proper cleanup of derived classes.

Detailed Description

Base class for plugin implementations with lifecycle node integration.

Provides common functionality for plugins including initialization, node management, and plugin identification within a ROS2 lifecycle framework.

Constructor & Destructor Documentation

◆ PluginBase()

roboligo::PluginBase::PluginBase ( )

default

Default constructor.

◆ ~PluginBase()

virtual roboligo::PluginBase::~PluginBase ( )

virtualdefault

Virtual destructor for proper cleanup of derived classes.

Member Function Documentation

◆ get_node()

std::shared_ptr< rclcpp_lifecycle::LifecycleNode > roboligo::PluginBase::get_node ( ) const

nodiscard

Retrieves the parent lifecycle node.

Returns: Shared pointer to the parent lifecycle node. @nodiscard The returned value should not be ignored.

◆ get_plugin_name()

const std::string & roboligo::PluginBase::get_plugin_name ( ) const

nodiscard

Retrieves the plugin name.

Returns: Const reference to the plugin name string. @nodiscard The returned value should not be ignored.

◆ initialize()

void roboligo::PluginBase::initialize	(	const std::shared_ptr< rclcpp_lifecycle::LifecycleNode >	parent_node,
		const std::string &	plugin_name )

virtual

Initializes the plugin with a parent lifecycle node and plugin name.

Parameters

parent_node	Shared pointer to the parent lifecycle node.
plugin_name	Name identifier for this plugin instance.

Reimplemented in roboligo::ClassificationBase, and roboligo::ConnectorBase.

◆ on_initialize()

virtual void roboligo::PluginBase::on_initialize ( )

inlinevirtual

Called during plugin initialization. Override in derived classes for custom setup.

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

roboligo_common/include/roboligo_common/types/PluginBase.hpp
roboligo_common/src/roboligo_common/types/PluginBase.cpp

Public Member Functions