Represents a configurable interface with name, type, mode, and value. More...

#include <Interface.hpp>

Public Member Functions
modes	get_mode (void)
	Retrieves the interface mode.
std::string	get_name (void)
	Retrieves the interface name.
types	get_type (void)
	Retrieves the interface type.
std::string	get_value (void)
	Retrieves the current value of the interface.
	Interface (std::string name, modes mode, std::string value)
	Constructs an Interface with the specified parameters.
void	set_value (std::string value)
	Updates the interface value.
void	show ()
	Displays the interface information. Outputs current interface properties to the standard output.
virtual	~Interface ()=default

Detailed Description

Represents a configurable interface with name, type, mode, and value.

This class manages interface properties including its name, operational mode, and current value. It provides methods to access and modify interface state.

Constructor & Destructor Documentation

◆ Interface()

roboligo::interfaces::Interface::Interface	(	std::string	name,
		modes	mode,
		std::string	value )

Constructs an Interface with the specified parameters.

Parameters

name	The interface name identifier.
mode	The operational mode of the interface.
value	The initial value of the interface.

◆ ~Interface()

virtual roboligo::interfaces::Interface::~Interface ( )

virtualdefault

Member Function Documentation

◆ get_mode()

modes roboligo::interfaces::Interface::get_mode ( void )

Retrieves the interface mode.

Returns: The operational mode of the interface.

◆ get_name()

std::string roboligo::interfaces::Interface::get_name ( void )

Retrieves the interface name.

Returns: The name of the interface as a string.

◆ get_type()

types roboligo::interfaces::Interface::get_type ( void )

Retrieves the interface type.

Returns: The type of the interface.

◆ get_value()

std::string roboligo::interfaces::Interface::get_value ( void )

Retrieves the current value of the interface.

Returns: The interface value as a string.

◆ set_value()

void roboligo::interfaces::Interface::set_value ( std::string value )

Updates the interface value.

Parameters

value The new value to set.

◆ show()

void roboligo::interfaces::Interface::show ( )

Displays the interface information. Outputs current interface properties to the standard output.

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

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

Public Member Functions