roboligo::Battery Class Reference

Sensor subclass for monitoring battery state information. More...

#include <Battery.hpp>

Inheritance diagram for roboligo::Battery:

Collaboration diagram for roboligo::Battery:

Public Member Functions
	Battery (std::string new_name, std::string new_topic)
	Constructor for Battery sensor.
void	callback (sensor_msgs::msg::BatteryState::SharedPtr msg)
	Callback function invoked when a new battery state message is received.
virtual	~Battery ()=default
	Virtual destructor.
Public Member Functions inherited from roboligo::Sensor
void	init (std::string new_name, std::string new_topic)
	Initializes the sensor with a name and topic.
	Sensor (std::string new_name, std::string new_topic)
	Constructor for Sensor.
virtual	~Sensor ()=default
	Virtual destructor.
Public Member Functions inherited from roboligo::Linker
interfaces::modes	get_mode ()
	Gets the current mode of the linker.
std::string	get_name ()
	Gets the linker name.
std::string	get_topic ()
	Gets the topic name.
bool	is_available (void)
	Checks if the linker is available.
bool	is_configured (void)
	Checks if the linker is configured.
	Linker ()
	Default constructor.
void	set_available (bool new_state)
	Sets the availability state.
void	set_configured (bool new_state)
	Sets the configuration state.
void	set_interface (std::string name_, std::string topic_name_)
	Configures the interface with name and topic.
void	set_mode (interfaces::modes new_mode)
	Sets the linker mode.
void	set_name (std::string new_name)
	Sets the linker name.
void	set_service (std::string new_name)
	Sets the service name.
void	set_topic (std::string new_name)
	Sets the topic name.
virtual	~Linker ()=default
	Virtual destructor.

Public Attributes
sensor_msgs::msg::BatteryState::SharedPtr	data
	Latest received battery state data.
rclcpp::Subscription< sensor_msgs::msg::BatteryState >::SharedPtr	subscriber
	ROS 2 subscription to receive BatteryState messages.
Public Attributes inherited from roboligo::Linker
std::shared_ptr< interfaces::Interface >	interface
	Shared pointer to the interface object.
std::string	name {"linker"}
	Linker identifier name.
std::string	topic_name {"/interface"}
	Associated topic name.

Additional Inherited Members
Protected Member Functions inherited from roboligo::Sensor
void	initialize (std::string new_name, std::string new_topic)
	Protected initialization method.
Protected Attributes inherited from roboligo::Sensor
interfaces::modes	mode_ {interfaces::modes::SUBSCRIBER}
	The connection mode set to SUBSCRIBER for receiving sensor data.
Protected Attributes inherited from roboligo::Linker
bool	available_ {false}
	Availability flag.
bool	configured_ {false}
	Configuration state flag.
interfaces::modes	mode_
	Current operating mode.

Detailed Description

Sensor subclass for monitoring battery state information.

Subscribes to battery state messages and stores the latest battery data. Inherits from Sensor base class.

Constructor & Destructor Documentation

Battery()

roboligo::Battery::Battery ( std::string new_name, std::string new_topic )

inline

Constructor for Battery sensor.

Parameters

new_name	The name identifier for this battery sensor.
new_topic	The ROS topic to subscribe to for battery messages.

~Battery()

virtual roboligo::Battery::~Battery ( )

virtualdefault

Virtual destructor.

Member Function Documentation

callback()

void roboligo::Battery::callback

(

sensor_msgs::msg::BatteryState::SharedPtr

msg

)

Callback function invoked when a new battery state message is received.

Parameters

msg	Shared pointer to the received BatteryState message.

Member Data Documentation

data

sensor_msgs::msg::BatteryState::SharedPtr roboligo::Battery::data

Latest received battery state data.

subscriber

rclcpp::Subscription<sensor_msgs::msg::BatteryState>::SharedPtr roboligo::Battery::subscriber

ROS 2 subscription to receive BatteryState messages.

---

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

• roboligo_common/include/roboligo_common/connector/sensors/Battery.hpp
• roboligo_common/src/roboligo_common/connector/sensors/Battery.cpp