Structure for storing information about a command line parameter. More...

#include <InputParameters.h>

Public Types
enum	ArgumentType { NONE, OPTIONAL, REQUIRED }

Public Attributes
std::string	syntax
	The syntax for the parameter. More...

std::vector< std::string >	switches
	The switches for the parameter (i.e., [-t, –timing]) More...

ArgumentType	argument_type
	The type of argument. More...

bool	required
	Whether or not the argument is required. More...

bool	set_by_command_line = false
	Whether or not the parameter was set by the CommandLine. More...

bool	global = false
	Whether or not the parameter is global (passed to MultiApps) More...

Detailed Description

Structure for storing information about a command line parameter.

Definition at line 79 of file InputParameters.h.

Member Enumeration Documentation

◆ ArgumentType

enum InputParameters::CommandLineMetadata::ArgumentType

Enumerator
NONE
OPTIONAL
REQUIRED

Definition at line 81 of file InputParameters.h.

     {
       NONE,
       OPTIONAL,
       REQUIRED
     };

Member Data Documentation

◆ argument_type

ArgumentType InputParameters::CommandLineMetadata::argument_type

The type of argument.

Definition at line 93 of file InputParameters.h.

Referenced by CommandLine::setCommandLineParam().

◆ global

bool InputParameters::CommandLineMetadata::global = false

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

Definition at line 99 of file InputParameters.h.

◆ required

bool InputParameters::CommandLineMetadata::required

Whether or not the argument is required.

Definition at line 95 of file InputParameters.h.

◆ set_by_command_line

bool InputParameters::CommandLineMetadata::set_by_command_line = false

Whether or not the parameter was set by the CommandLine.

Definition at line 97 of file InputParameters.h.

◆ switches

std::vector<std::string> InputParameters::CommandLineMetadata::switches

The switches for the parameter (i.e., [-t, –timing])

Definition at line 91 of file InputParameters.h.

Referenced by MooseApp::copyInputs(), and MooseApp::showInputs().

◆ syntax

std::string InputParameters::CommandLineMetadata::syntax

The syntax for the parameter.

Definition at line 89 of file InputParameters.h.

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

include/utils/InputParameters.h

Public Types

Public Attributes