n2nc::utils::args::ValidArgument Class Reference

This class represents a expected argument. More...

#include <validargument.h>

List of all members.

Public Member Functions
	ValidArgument (string name)
string	toString ()
Static Public Member Functions
static ValidArgument *	find (string name, vector< ValidArgument > &valids)
Public Attributes
bool	paramrequired
std::string	name
std::string	comment
std::string	defaultparam
std::vector< std::string >	paramlist
std::vector< std::string >	paramlist_pattern
std::vector< std::string >	dependsof
std::vector< std::string >	conflictsto

---

Detailed Description

This class represents a expected argument.

Author:

fabsoft <fabsoft@gmail.com>

Examples:

argument_ex.cpp.

Definition at line 16 of file validargument.h.

---

Member Data Documentation

bool n2nc::utils::args::ValidArgument::paramrequired

Indicates if a parameter is mandatory.

Examples:

argument_ex.cpp.

Definition at line 28 of file validargument.h.

std::string n2nc::utils::args::ValidArgument::name

The name of argument.

Definition at line 30 of file validargument.h.

std::string n2nc::utils::args::ValidArgument::comment

The comment to be displayed by ArgumentsHelper::dumpAllValid()

Examples:

argument_ex.cpp.

Definition at line 32 of file validargument.h.

std::string n2nc::utils::args::ValidArgument::defaultparam

If the param is not required and a a parameter is not supplied the assuming defaultparam

Examples:

argument_ex.cpp.

Definition at line 34 of file validargument.h.

std::vector<std::string> n2nc::utils::args::ValidArgument::paramlist

A list of expected parameters for this argument.

Examples:

argument_ex.cpp.

Definition at line 36 of file validargument.h.

std::vector<std::string> n2nc::utils::args::ValidArgument::paramlist_pattern

A list of expected patternized parameters for this argument.

Definition at line 38 of file validargument.h.

std::vector<std::string> n2nc::utils::args::ValidArgument::dependsof

A list of dependant arguments(name) for this argument.

Examples:

argument_ex.cpp.

Definition at line 40 of file validargument.h.

Referenced by n2nc::utils::args::Argument::checkForDependecies().

std::vector<std::string> n2nc::utils::args::ValidArgument::conflictsto

A list of conlictual arguments(name) for this argument.

Definition at line 42 of file validargument.h.

Referenced by n2nc::utils::args::Argument::checkForConflicts().

---

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

• validargument.h
• validargument.cpp