CommandLine::Entry Struct Reference

Stores name/value pairs for each command line argument. More...

#include <CommandLine.h>

Public Attributes
std::string	name
	The name, i.e, ["-foo=bar"] -> "-foo" or ["--foo", "bar"] -> "--foo". More...
std::optional< std::string >	subapp_name
	The name of the subapp, if any (with subapp:something=value syntax) More...
std::optional< std::string >	value
	The value, i.e. ["-foo=bar"] -> "bar" or ["-foo"] -> empty, if any. More...
std::optional< std::string >	value_separator
	The string that separates the value, if a value exists (space or =) More...
std::vector< std::string >	raw_args
	The raw arguments that represent these split values. More...
bool	used = false
	Whether or not this set of arguments was used. More...
bool	global = false
	Whether or not this parameter is global (passed to MultiApps) More...
bool	hit_param = false
	Whether or not this parameter is recognized as a HIT parameter. More...

Detailed Description

Stores name/value pairs for each command line argument.

Definition at line 36 of file CommandLine.h.

Member Data Documentation

global

bool CommandLine::Entry::global = false

Whether or not this parameter is global (passed to MultiApps)

Definition at line 51 of file CommandLine.h.

hit_param

bool CommandLine::Entry::hit_param = false

Whether or not this parameter is recognized as a HIT parameter.

Definition at line 53 of file CommandLine.h.

name

std::string CommandLine::Entry::name

The name, i.e, ["-foo=bar"] -> "-foo" or ["--foo", "bar"] -> "--foo".

Definition at line 39 of file CommandLine.h.

Referenced by CommandLine::formatEntry().

raw_args

std::vector<std::string> CommandLine::Entry::raw_args

The raw arguments that represent these split values.

Definition at line 47 of file CommandLine.h.

subapp_name

std::optional<std::string> CommandLine::Entry::subapp_name

The name of the subapp, if any (with subapp:something=value syntax)

Definition at line 41 of file CommandLine.h.

used

bool CommandLine::Entry::used = false

Whether or not this set of arguments was used.

Definition at line 49 of file CommandLine.h.

value

std::optional<std::string> CommandLine::Entry::value

The value, i.e. ["-foo=bar"] -> "bar" or ["-foo"] -> empty, if any.

Definition at line 43 of file CommandLine.h.

Referenced by CommandLine::formatEntry().

value_separator

std::optional<std::string> CommandLine::Entry::value_separator

The string that separates the value, if a value exists (space or =)

Definition at line 45 of file CommandLine.h.

Referenced by CommandLine::formatEntry().

---

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

• include/parser/CommandLine.h