fp_perception::AlgorithmBase Class Reference

#include <algorithm_base.hpp>

Public Member Functions
virtual	~AlgorithmBase ()=default
virtual void	initialize (const rclcpp::Node::SharedPtr &node)
	Initialize the driver with a ROS node and namespace.
virtual void	start ()=0
	Start the algorithm.
virtual void	stop ()=0
	Stop the algorithm.
virtual std::string	getName () const
	Get the name of the algorithm.
void	set_vision_driver (const std::shared_ptr< fp_perception::DriverBase > &vision_driver)
	Set the vision driver shared pointer.
void	set_audio_input_driver (const std::shared_ptr< fp_perception::DriverBase > &audio_driver)
	Set the audio input driver shared pointer.
void	set_transcription_driver (const std::shared_ptr< fp_perception::DriverBase > &transcription_driver)
	Set the transcription driver shared pointer.
void	set_sentiment_driver (const std::shared_ptr< fp_perception::DriverBase > &sentiment_driver)
	Set the sentiment driver shared pointer.

Protected Member Functions
void	initialize_base (const rclcpp::Node::SharedPtr &node)
	Initializer base driver in place of constructor due to plugin semantics.

Protected Attributes
rclcpp::Node::SharedPtr	node_
	ROS node for the driver.
algorithm_options	config_
	algorithm options
std::shared_ptr< fp_perception::DriverBase >	vision_driver_
	driver for vision
std::shared_ptr< fp_perception::DriverBase >	audio_input_driver_
	driver for audio input
std::shared_ptr< fp_perception::DriverBase >	transcription_driver_
	driver for transcription
std::shared_ptr< fp_perception::DriverBase >	sentiment_driver_
	driver for sentiment analysis

Constructor & Destructor Documentation

~AlgorithmBase()

virtual fp_perception::AlgorithmBase::~AlgorithmBase ( )

virtualdefault

Member Function Documentation

getName()

virtual std::string fp_perception::AlgorithmBase::getName ( ) const

inlinevirtual

Get the name of the algorithm.

This function returns the name of the algorithm. It can be overridden by derived classes to provide specific implementations.

Returns

Name of the algorithm

initialize()

virtual void fp_perception::AlgorithmBase::initialize ( const rclcpp::Node::SharedPtr &  node )

inlinevirtual

Initialize the driver with a ROS node and namespace.

Parameters

node	Shared pointer to the ROS node

initialize_base()

void fp_perception::AlgorithmBase::initialize_base ( const rclcpp::Node::SharedPtr &  node )

inlineprotected

Initializer base driver in place of constructor due to plugin semantics.

Parameters

node	shared pointer to the ROS node.

set_audio_input_driver()

void fp_perception::AlgorithmBase::set_audio_input_driver ( const std::shared_ptr< fp_perception::DriverBase > &  audio_driver )

inline

Set the audio input driver shared pointer.

Parameters

audio_driver

set_sentiment_driver()

void fp_perception::AlgorithmBase::set_sentiment_driver ( const std::shared_ptr< fp_perception::DriverBase > &  sentiment_driver )

inline

Set the sentiment driver shared pointer.

Parameters

sentiment_driver

set_transcription_driver()

void fp_perception::AlgorithmBase::set_transcription_driver ( const std::shared_ptr< fp_perception::DriverBase > &  transcription_driver )

inline

Set the transcription driver shared pointer.

Parameters

transcription_driver

set_vision_driver()

void fp_perception::AlgorithmBase::set_vision_driver ( const std::shared_ptr< fp_perception::DriverBase > &  vision_driver )

inline

Set the vision driver shared pointer.

Parameters

vision_driver

start()

virtual void fp_perception::AlgorithmBase::start ( )

pure virtual

Start the algorithm.

stop()

virtual void fp_perception::AlgorithmBase::stop ( )

pure virtual

Stop the algorithm.

Member Data Documentation

audio_input_driver_

std::shared_ptr<fp_perception::DriverBase> fp_perception::AlgorithmBase::audio_input_driver_

protected

driver for audio input

config_

algorithm_options fp_perception::AlgorithmBase::config_

protected

algorithm options

node_

rclcpp::Node::SharedPtr fp_perception::AlgorithmBase::node_

protected

ROS node for the driver.

sentiment_driver_

std::shared_ptr<fp_perception::DriverBase> fp_perception::AlgorithmBase::sentiment_driver_

protected

driver for sentiment analysis

transcription_driver_

std::shared_ptr<fp_perception::DriverBase> fp_perception::AlgorithmBase::transcription_driver_

protected

driver for transcription

vision_driver_

std::shared_ptr<fp_perception::DriverBase> fp_perception::AlgorithmBase::vision_driver_

protected

driver for vision

---

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

• fp_perception_base/include/fp_perception_base/algorithm_base.hpp