Command Line application parser More...

Static Public Member Functions
static Dictionary< string, object >	Parse (string applicationName, string applicationDescription, string applicationHelpText, string[] args, List< CommandLineOption > options, bool noArgsShowHelp=false)
	This function will parse args based on options and will show application name, version, help More...

static void	PrintMessageAndExit (int exitCode=0, string message="")
	Prints a message advising the user to use the –help parameter for more information More...

static string	GetParameterOrExit (IReadOnlyDictionary< string, object > optionsObject, string parameter)
	Gets the parameter object from the given parameter (if it exists) More...

static string	GetParameterOrDefault (IReadOnlyDictionary< string, object > optionsObject, string parameter, string defaultValue)
	Gets the parameter object from the given parameter. If it does not exists, it returns a default parameter object More...

Detailed Description

Command Line application parser

Definition at line 12 of file ApplicationParser.cs.

Member Function Documentation

static Dictionary<string, object> QuantConnect.Configuration.ApplicationParser.Parse	(	string	applicationName,
		string	applicationDescription,
		string	applicationHelpText,
		string[]	args,
		List< CommandLineOption >	options,
		bool	noArgsShowHelp = `false`
	)

static

This function will parse args based on options and will show application name, version, help

Parameters

applicationName	The application name to be shown
applicationDescription	The application description to be shown
applicationHelpText	The application help text
args	The command line arguments
options	The applications command line available options
noArgsShowHelp	To show help when no command line arguments were provided

Definition at line 24 of file ApplicationParser.cs.

Here is the caller graph for this function:

static void QuantConnect.Configuration.ApplicationParser.PrintMessageAndExit	(	int	exitCode = `0`,
		string	message = `""`
	)

static

Prints a message advising the user to use the –help parameter for more information

Definition at line 100 of file ApplicationParser.cs.

static string QuantConnect.Configuration.ApplicationParser.GetParameterOrExit	(	IReadOnlyDictionary< string, object >	optionsObject,
		string	parameter
	)

static

Gets the parameter object from the given parameter (if it exists)

Definition at line 115 of file ApplicationParser.cs.

static string QuantConnect.Configuration.ApplicationParser.GetParameterOrDefault	(	IReadOnlyDictionary< string, object >	optionsObject,
		string	parameter,
		string	defaultValue
	)

static

Gets the parameter object from the given parameter. If it does not exists, it returns a default parameter object

Definition at line 127 of file ApplicationParser.cs.

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