SuPReMo  0.1.1
Loading...
Searching...
No Matches
Public Attributes | List of all members
CommandLineOption Struct Reference

#include <CommandLineParser.h>

Public Attributes

unsigned int numberOfComponents
 Number of elements expected after this flag on the command line. A switch will be 0, a single item 1, etc. More...
 
bool required
 Indicating if this parameters is essential to run the program. If a given parameter marked by required is not found on the command line a warning will be printed. More...
 
std::string description
 Detailed description of the parameter. This will be used to generate the help message on the command line. More...
 
std::string format
 String describing the format of the parameter, e.g. <int>, <filename>, etc. More...
 

Detailed Description

Structure holding the basic information about a single command line option.

Member Data Documentation

◆ description

std::string CommandLineOption::description

Detailed description of the parameter. This will be used to generate the help message on the command line.

◆ format

std::string CommandLineOption::format

String describing the format of the parameter, e.g. <int>, <filename>, etc.

◆ numberOfComponents

unsigned int CommandLineOption::numberOfComponents

Number of elements expected after this flag on the command line. A switch will be 0, a single item 1, etc.

◆ required

bool CommandLineOption::required

Indicating if this parameters is essential to run the program. If a given parameter marked by required is not found on the command line a warning will be printed.


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