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

Public Member Functions

CmdLineParserConfigFileOptionoperator= (const CmdLineParserConfigFileOption &other)=delete
 
 CmdLineParserConfigFileOption (const CmdLineParserConfigFileOption &other)=delete
 
CmdLineParserConfigFileOptionoperator= (CmdLineParserConfigFileOption &&)=delete
 
 CmdLineParserConfigFileOption (CmdLineParserConfigFileOption &&other)=delete
 
cxx::expected< CmdLineArgs_t, CmdLineParserResult > parse (int argc, char *argv[], const CmdLineArgumentParsingMode cmdLineParsingMode=CmdLineArgumentParsingMode::ALL) noexcept override
 process the passed command line arguments More...
 
- Public Member Functions inherited from iox::config::CmdLineParser
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

roudi::ConfigFilePathString_t m_customConfigFilePath
 
- Protected Attributes inherited from iox::config::CmdLineParser
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}
 

Additional Inherited Members

- Public Types inherited from iox::config::CmdLineParser
enum class  CmdLineArgumentParsingMode { ALL , ONE }
 

Member Function Documentation

◆ parse()

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

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 from iox::config::CmdLineParser.


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