Skip to content

iox::config::CmdLineParser🔗

Inherited by iox::config::CmdLineParserConfigFileOption

Public Types🔗

Name
enum CmdLineArgumentParsingMode { ALL, ONE}

Public Functions🔗

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

Protected Attributes🔗

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 Types Documentation🔗

enum CmdLineArgumentParsingMode🔗

Enumerator Value Description
ALL
ONE

Public Functions Documentation🔗

function CmdLineParser🔗

CmdLineParser() =default

function ~CmdLineParser🔗

virtual ~CmdLineParser() =default

function operator=🔗

CmdLineParser & operator=(
    const CmdLineParser & other
)

function CmdLineParser🔗

CmdLineParser(
    const CmdLineParser & other
)

function operator=🔗

CmdLineParser & operator=(
    CmdLineParser && 
)

function CmdLineParser🔗

CmdLineParser(
    CmdLineParser && other
)

function parse🔗

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

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

Reimplemented by: iox::config::CmdLineParserConfigFileOption::parse

Protected Attributes Documentation🔗

variable m_run🔗

bool m_run {true};

variable m_logLevel🔗

iox::log::LogLevel m_logLevel {iox::log::LogLevel::kWarn};

variable m_monitoringMode🔗

roudi::MonitoringMode m_monitoringMode {roudi::MonitoringMode::ON};

variable m_compatibilityCheckLevel🔗

version::CompatibilityCheckLevel m_compatibilityCheckLevel {version::CompatibilityCheckLevel::PATCH};

variable m_uniqueRouDiId🔗

cxx::optional< uint16_t > m_uniqueRouDiId;

variable m_processKillDelay🔗

units::Duration m_processKillDelay {roudi::PROCESS_DEFAULT_KILL_DELAY};

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