PicoScenes API Docs
 
Loading...
Searching...
No Matches
AbstractHALConfiguration Class Referenceabstract

Abstract base class for Hardware Abstraction Layer (HAL) configuration. More...

#include <AbstractHALConfiguration.hxx>

Public Member Functions

 AbstractHALConfiguration (const std::shared_ptr< AbstractNIC > &nic)
 Constructor for AbstractHALConfiguration.
 
virtual void applyConfiguration (const pt::ptree &config)=0
 Apply configuration settings to the hardware.
 
virtual std::shared_ptr< po::options_description > getHALOptions ()=0
 Get the available HAL options for this hardware.
 
virtual void parseAndExecuteCommands (const std::string &command)=0
 Parse and execute hardware-specific commands.
 

Protected Attributes

std::shared_ptr< AbstractNICnic
 Protected member storing the network interface card instance.
 

Detailed Description

Abstract base class for Hardware Abstraction Layer (HAL) configuration.

This class serves as an interface for managing hardware configurations across different types of network interface cards (NICs). It provides methods for applying configurations, getting HAL options, and executing commands.

Definition at line 19 of file AbstractHALConfiguration.hxx.

Constructor & Destructor Documentation

◆ AbstractHALConfiguration()

AbstractHALConfiguration::AbstractHALConfiguration ( const std::shared_ptr< AbstractNIC > &  nic)
inlineexplicit

Constructor for AbstractHALConfiguration.

Parameters
nicShared pointer to the AbstractNIC instance that this configuration will manage

Definition at line 25 of file AbstractHALConfiguration.hxx.

Member Function Documentation

◆ applyConfiguration()

virtual void AbstractHALConfiguration::applyConfiguration ( const pt::ptree &  config)
pure virtual

Apply configuration settings to the hardware.

Parameters
configProperty tree containing configuration parameters

This pure virtual function must be implemented by derived classes to apply specific configuration settings to their respective hardware.

◆ getHALOptions()

virtual std::shared_ptr< po::options_description > AbstractHALConfiguration::getHALOptions ( )
pure virtual

Get the available HAL options for this hardware.

Returns
Shared pointer to options_description containing all available HAL options

This pure virtual function must be implemented by derived classes to provide hardware-specific configuration options.

◆ parseAndExecuteCommands()

virtual void AbstractHALConfiguration::parseAndExecuteCommands ( const std::string &  command)
pure virtual

Parse and execute hardware-specific commands.

Parameters
commandString containing the command to be executed

This pure virtual function must be implemented by derived classes to handle hardware-specific command parsing and execution.

Member Data Documentation

◆ nic

std::shared_ptr<AbstractNIC> AbstractHALConfiguration::nic
protected

Protected member storing the network interface card instance.

This shared pointer provides access to the NIC that this configuration manages. It's protected to allow derived classes to access the hardware interface.

Definition at line 61 of file AbstractHALConfiguration.hxx.


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