iceoryx_posh 2.0.3
Public Types | Public Member Functions | Protected Attributes | List of all members
iox::config::CmdLineParser Class Reference
Inheritance diagram for iox::config::CmdLineParser:
Inheritance graph
[legend]

Public Types

enum class  CmdLineArgumentParsingMode { ALL , ONE }
 

Public Member Functions

CmdLineParseroperator= (const CmdLineParser &other)=delete
 
 CmdLineParser (const CmdLineParser &other)=delete
 
CmdLineParseroperator= (CmdLineParser &&)=delete
 
 CmdLineParser (CmdLineParser &&other)=delete
 
virtual cxx::expected< CmdLineArgs_t, CmdLineParserResult > parse (int argc, char *argv[], const CmdLineArgumentParsingMode cmdLineParsingMode=CmdLineArgumentParsingMode::ALL) noexcept
 process the passed command line arguments More...
 

Protected Attributes

bool m_run {true}
 
iox::log::LogLevel m_logLevel {iox::log::LogLevel::kWarn}
 
roudi::MonitoringMode m_monitoringMode {roudi::MonitoringMode::ON}
 
version::CompatibilityCheckLevel m_compatibilityCheckLevel {version::CompatibilityCheckLevel::PATCH}
 
cxx::optional< uint16_t > m_uniqueRouDiId
 
units::Duration m_processKillDelay {roudi::PROCESS_DEFAULT_KILL_DELAY}
 

Member Function Documentation

◆ parse()

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

process the passed command line arguments

Parameters
[in]argcforwarding of command line arguments
[in]argvforwarding of command line arguments
[in]cmdLineParsingModeselects to parse a single option or all options
[out]Resultwrapped in an cxx::expected, either the parsed arguments as CmdLineArgs_t struct or CmdLineParserResult

Reimplemented in iox::config::CmdLineParserConfigFileOption.


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