roboligo
Loading...
Searching...
No Matches
roboligo::Service Class Reference

A service commander that extends the Commander interface. More...

#include <Service.hpp>

Inheritance diagram for roboligo::Service:
Collaboration diagram for roboligo::Service:

Public Member Functions

 Service (std::string new_name, std::string new_value)
 Constructs a Service commander with the specified name and value.
virtual ~Service ()=default
Public Member Functions inherited from roboligo::Commander
 Commander (std::string new_name, std::string new_value)
 Constructor for Commander.
void init (std::string new_name, std::string new_value)
 Initialize the commander with name and value.
bool is_stamped (void)
 Check if timestamp stamping is enabled.
void set_stamp (bool stamped)
 Enable or disable timestamp stamping for messages.
virtual ~Commander ()=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.

Additional Inherited Members

Public Attributes inherited from roboligo::Linker
std::shared_ptr< interfaces::Interfaceinterface
 Shared pointer to the interface object.
std::string name {"linker"}
 Linker identifier name.
std::string topic_name {"/interface"}
 Associated topic name.
Protected Member Functions inherited from roboligo::Commander
void initialize (std::string new_name, std::string new_topic)
 Protected initialization method.
Protected Attributes inherited from roboligo::Commander
bool use_stamp_ {true}
 Flag indicating whether to include timestamps in published messages.
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

A service commander that extends the Commander interface.

This class represents a service-based command handler within the roboligo system. It provides functionality to manage service commands with a name and value pair.

Note
Implementation is pending (TODO).

Constructor & Destructor Documentation

◆ Service()

roboligo::Service::Service ( std::string new_name,
std::string new_value )

Constructs a Service commander with the specified name and value.

Parameters
new_nameThe name identifier for the service.
new_valueThe value associated with the service.

◆ ~Service()

virtual roboligo::Service::~Service ( )
virtualdefault

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