roboligo::ClassificationBase Class Reference

Base class for classification plugins in the Roboligo system. More...

#include <ClassificationBase.hpp>

Inheritance diagram for roboligo::ClassificationBase:

Collaboration diagram for roboligo::ClassificationBase:

Public Member Functions
	ClassificationBase ()=default
	constructor
virtual void	initialize (const std::shared_ptr< rclcpp_lifecycle::LifecycleNode > parent_node, const std::string &plugin_name)
	Initializes the classification plugin.
virtual bool	set (RobotState &robot_state)
	Sets the robot state classification.
virtual bool	update (RobotState &robot_state)
	Updates the robot state classification.
virtual	~ClassificationBase ()=default
	Destructor.
Public Member Functions inherited from roboligo::PluginBase
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	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.

Protected Member Functions
virtual void	on_set (RobotState &robot_state)
	Called when setting robot state (override in derived classes).
virtual void	on_update (RobotState &robot_state)
	Called when updating robot state (override in derived classes).

Detailed Description

Base class for classification plugins in the Roboligo system.

ClassificationBase provides an abstract interface for implementing classification functionality within the robot control framework. It inherits from PluginBase and follows a plugin architecture pattern, allowing extensibility through derived classes.

Constructor & Destructor Documentation

ClassificationBase()

roboligo::ClassificationBase::ClassificationBase ( )

default

constructor

~ClassificationBase()

virtual roboligo::ClassificationBase::~ClassificationBase ( )

virtualdefault

Destructor.

Member Function Documentation

initialize()

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

virtual

Initializes the classification plugin.

Parameters

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

Reimplemented from roboligo::PluginBase.

on_set()

virtual void roboligo::ClassificationBase::on_set ( RobotState & robot_state )

inlineprotectedvirtual

Called when setting robot state (override in derived classes).

Parameters

robot_state

Reference to the robot state being set.

on_update()

virtual void roboligo::ClassificationBase::on_update ( RobotState & robot_state )

inlineprotectedvirtual

Called when updating robot state (override in derived classes).

Parameters

robot_state

Reference to the robot state being updated.

set()

bool roboligo::ClassificationBase::set ( RobotState & robot_state )

virtual

Sets the robot state classification.

Parameters

robot_state

Reference to the robot state to classify.

Returns

True if the operation succeeded, false otherwise.

update()

bool roboligo::ClassificationBase::update ( RobotState & robot_state )

virtual

Updates the robot state classification.

Parameters

robot_state

Reference to the robot state to update.

Returns

True if the operation succeeded, false otherwise.

---

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

• roboligo_common/include/roboligo_common/classification/ClassificationBase.hpp
• roboligo_common/src/roboligo_common/classification/ClassificationBase.cpp