Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup Interface Reference

A group of arguments that cannot appear together in the input string: they are mutually exclusive. More...

Public Member Functions
void	AddArgument (ParserArgument argument, string name=null)
	Adds a new argument to the group. More...
void	AddArgument (string name, ParserArgument argument)
	Adds a new argument that is identified by its name to the group. More...
void	AddArgument (string name, string alternative, ParserArgument argument)
	Adds a new argument that is identified by its name or an alternative name to the group. More...
void	AddArgument< FlagValueType > (FlagArgument< FlagValueType > argument)
	Adds a new argument that represents a flag. More...

Properties
String	Name [get]
	The name of the group. More...
bool	IsRequired [get]
	Determines if one of the arguments in the group is required to occur in the input string. More...

Detailed Description

A group of arguments that cannot appear together in the input string: they are mutually exclusive.

Since

0.2.0

Member Function Documentation

AddArgument() [1/3]

void Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup.AddArgument	(	ParserArgument	argument,
		string	name = null
	)

Adds a new argument to the group.

Parameters

argument	the new argument
name	the name that identifies the argument

AddArgument() [2/3]

void Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup.AddArgument	(	string	name,
		ParserArgument	argument
	)

Adds a new argument that is identified by its name to the group.

Parameters

name	the name that identifies this argument
argument	the argument

Since

0.2.0

AddArgument() [3/3]

void Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup.AddArgument	(	string	name,
		string	alternative,
		ParserArgument	argument
	)

Adds a new argument that is identified by its name or an alternative name to the group.

Parameters

name	the name that identifies this argument in the input list
alternative	the alternative name that identifies this argument in the input list
argument	the argument

Remarks

This method is a shorthand for registering an argument with a short an a long name. E.g. -a and –active.

AddArgument< FlagValueType >()

void Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup.AddArgument< FlagValueType >

(

FlagArgument< FlagValueType >

argument

)

Adds a new argument that represents a flag.

Since

0.2.0

Property Documentation

IsRequired

bool Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup.IsRequired

get

Determines if one of the arguments in the group is required to occur in the input string.

Implemented in Joutsen.ArgumentsParsing.Groups.DefaultMutuallyExclusiveArgumentsGroup.

Name

String Joutsen.ArgumentsParsing.MutuallyExclusiveArgumentsGroup.Name

get

The name of the group.

Implemented in Joutsen.ArgumentsParsing.Groups.DefaultMutuallyExclusiveArgumentsGroup.