Skip to content

iox::config::CmdLineParserConfigFileOption🔗

Inherits from iox::config::CmdLineParser

Public Functions🔗

Name
CmdLineParserConfigFileOption() =default
virtual ~CmdLineParserConfigFileOption() =default
CmdLineParserConfigFileOption & operator=(const CmdLineParserConfigFileOption & other)
CmdLineParserConfigFileOption(const CmdLineParserConfigFileOption & other)
CmdLineParserConfigFileOption & operator=(CmdLineParserConfigFileOption && )
CmdLineParserConfigFileOption(CmdLineParserConfigFileOption && other)
virtual cxx::expected< CmdLineArgs_t, CmdLineParserResult > parse(int argc, char * argv[], const CmdLineArgumentParsingMode cmdLineParsingMode =CmdLineArgumentParsingMode::ALL) override
process the passed command line arguments

Protected Attributes🔗

Name
roudi::ConfigFilePathString_t m_customConfigFilePath

Additional inherited members🔗

Public Types inherited from iox::config::CmdLineParser

Name
enum CmdLineArgumentParsingMode { ALL, ONE}

Public Functions inherited from iox::config::CmdLineParser

Name
CmdLineParser() =default
virtual ~CmdLineParser() =default
CmdLineParser(const CmdLineParser & other)
CmdLineParser(CmdLineParser && other)

Protected Attributes inherited from iox::config::CmdLineParser

Name
bool m_run
iox::log::LogLevel m_logLevel
roudi::MonitoringMode m_monitoringMode
version::CompatibilityCheckLevel m_compatibilityCheckLevel
cxx::optional< uint16_t > m_uniqueRouDiId
units::Duration m_processKillDelay

Public Functions Documentation🔗

function CmdLineParserConfigFileOption🔗

CmdLineParserConfigFileOption() =default

function ~CmdLineParserConfigFileOption🔗

virtual ~CmdLineParserConfigFileOption() =default

function operator=🔗

CmdLineParserConfigFileOption & operator=(
    const CmdLineParserConfigFileOption & other
)

function CmdLineParserConfigFileOption🔗

CmdLineParserConfigFileOption(
    const CmdLineParserConfigFileOption & other
)

function operator=🔗

CmdLineParserConfigFileOption & operator=(
    CmdLineParserConfigFileOption && 
)

function CmdLineParserConfigFileOption🔗

CmdLineParserConfigFileOption(
    CmdLineParserConfigFileOption && other
)

function parse🔗

virtual cxx::expected< CmdLineArgs_t, CmdLineParserResult > parse(
    int argc,
    char * argv[],
    const CmdLineArgumentParsingMode cmdLineParsingMode =CmdLineArgumentParsingMode::ALL
) override

process the passed command line arguments

Parameters:

  • argc forwarding of command line arguments
  • argv forwarding of command line arguments
  • cmdLineParsingMode selects to parse a single option or all options
  • Result wrapped in an cxx::expected, either the parsed arguments as CmdLineArgs_t struct or CmdLineParserResult

Reimplements: iox::config::CmdLineParser::parse

Protected Attributes Documentation🔗

variable m_customConfigFilePath🔗

roudi::ConfigFilePathString_t m_customConfigFilePath;

Updated on 18 December 2023 at 13:11:43 CET