iceoryx_posh 2.0.3
Public Member Functions | Protected Attributes | List of all members
iox::roudi::RouDiConfigFileProvider Class Referenceabstract

Base class for a config file provider. More...

#include <iceoryx_posh/roudi/roudi_config_file_provider.hpp>

Inheritance diagram for iox::roudi::RouDiConfigFileProvider:
Inheritance graph
[legend]

Public Member Functions

virtual cxx::expected< RouDiConfig_t, RouDiConfigFileParseErrorparse () noexcept=0
 interface to parse a config file which needs to be implemented for a custom parser More...
 

Protected Attributes

ConfigFilePathString_t m_customConfigFilePath
 

Detailed Description

Base class for a config file provider.

Member Function Documentation

◆ parse()

virtual cxx::expected< RouDiConfig_t, RouDiConfigFileParseError > iox::roudi::RouDiConfigFileProvider::parse ( )
pure virtualnoexcept

interface to parse a config file which needs to be implemented for a custom parser

Parameters
[in]configFilePathto the custom RouDi config file
Returns
a cxx::expected with either the parsed RouDiConfig_t if the parsing was successful or a parsing error

Implemented in iox::config::TomlRouDiConfigFileProvider.


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