Developer documentation
Version 3.0.3-105-gd3941f44
MR::App::ParsedOption Class Reference

object storing information about option parsed from command-line More...

#include "app.h"

Public Member Functions

 ParsedOption (const Option *option, const char *const *arguments)
 
const ParsedArgument operator[] (size_t num) const
 
bool operator== (const char *match) const
 check whether this option matches the name supplied More...
 

Public Attributes

const Optionopt
 reference to the corresponding Option entry in the OPTIONS section More...
 
const char *const * args
 pointer into argv corresponding to the option's first argument More...
 

Detailed Description

object storing information about option parsed from command-line

this is the object stored in the App::options vector, and the type returned by App::get_options().

Definition at line 286 of file app.h.

Constructor & Destructor Documentation

◆ ParsedOption()

MR::App::ParsedOption::ParsedOption ( const Option option,
const char *const *  arguments 
)
inline

Definition at line 288 of file app.h.

Member Function Documentation

◆ operator==()

bool MR::App::ParsedOption::operator== ( const char *  match) const
inline

check whether this option matches the name supplied

Definition at line 323 of file app.h.

◆ operator[]()

const ParsedArgument MR::App::ParsedOption::operator[] ( size_t  num) const
inline

Definition at line 317 of file app.h.

Member Data Documentation

◆ args

const char* const* MR::App::ParsedOption::args

pointer into argv corresponding to the option's first argument

Definition at line 315 of file app.h.

◆ opt

const Option* MR::App::ParsedOption::opt

reference to the corresponding Option entry in the OPTIONS section

Definition at line 313 of file app.h.


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