Collaboration diagram for Nextsim::CommandLineParser:

Public Member Functions
	CommandLineParser (int argc, char *argv[])

std::vector< std::string >	getConfigFileNames ()

std::string	configHelp ()

Static Public Attributes
static const std::string	allModuleString = ConfigurationHelpPrinter::allStr

static const std::string	availableModuleString = ConfigurationHelpPrinter::availStr

Detailed Description

A class to parse the neXtSIM_DG command line.

Definition at line 20 of file CommandLineParser.hpp.

Constructor & Destructor Documentation

Nextsim::CommandLineParser::CommandLineParser	(	int	argc,
		char *	argv[] )

Parse the command line for command line options.

Parameters

argc	the count of passed arguments.
argv	The array of C strings passed as arguments.

Definition at line 28 of file CommandLineParser.cpp.

std::string Nextsim::CommandLineParser::configHelp ( )

inline

Returns the name of any module for which help was requested.

Definition at line 40 of file CommandLineParser.hpp.

std::vector< std::string > Nextsim::CommandLineParser::getConfigFileNames ( )

Return a std::vector of the file names declared as config files on the command line, in order.

Return a std::vector of the file names declared as config files on the command line

Definition at line 82 of file CommandLineParser.cpp.

const std::string Nextsim::CommandLineParser::allModuleString = ConfigurationHelpPrinter::allStr

static

The special string denoting help for all available modules.

Definition at line 45 of file CommandLineParser.hpp.

const std::string Nextsim::CommandLineParser::availableModuleString = ConfigurationHelpPrinter::availStr

static

The special string denoting a request for listing available modules.

Definition at line 50 of file CommandLineParser.hpp.

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