|
ParamKit
A small library helping to parse commandline parameters (for Windows).
|
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
ParamKit
A small library helping to parse commandline parameters (for Windows).
|
A parameter storing a boolean value. More...
#include <param.h>
Public Member Functions | |
| BoolParam (const std::string &_argStr, bool _isRequired) | |
| virtual std::string | type () const |
| Returns the string representation of the parameter's type. More... | |
| virtual std::string | valToString () const |
| Returns the string representation of the parameter's value. More... | |
| virtual bool | isSet () const |
| Returns true if the parameter is filled, false otherwise. More... | |
| virtual bool | parse (const char *arg=nullptr) |
| Parses the parameter from the given string. More... | |
 Public Member Functions inherited from paramkit::Param | |
| Param (const std::string &_argStr, bool _isRequired) | |
| A constructor of a parameter. More... | |
| Param (const std::string &_argStr, const std::string &_typeDescStr, bool _isRequired) | |
| A constructor of a parameter. More... | |
| virtual bool | parse (const wchar_t *arg) |
| Parses the parameter from the given wide string. More... | |
| void | setActive (bool _active) |
| virtual bool | isActive () const |
| Returns true if the parameter is active, false otherwise. More... | |
| virtual std::string | info (bool isExtended) const |
| void | printInColor (int color) |
| Prints the parameter using the given color. Appends the parameter switch to the name. More... | |
Public Attributes | |
| bool | value |
| bool | isParsed |
Additional Inherited Members | |
| Protected Member Functions inherited from paramkit::Param | |
| void | printDesc (bool isExtended=true) const |
| Prints a formatted description of the parameter, including its unique name, type, and the info. More... | |
| virtual bool | isNameSimilar (const std::string &filter) |
| Checks if the param name is similar to the given filter. More... | |
| virtual bool | isKeywordInType (const std::string &keyword) |
| Checks if the parameter type contains the keyword. More... | |
| virtual bool | isKeywordInDescription (const std::string &keyword) |
| Checks if the description contains the keyword. More... | |
| virtual std::string | extendedInfo () const |
| Extended information. More... | |
| Protected Attributes inherited from paramkit::Param | |
| std::string | argStr |
| a unique name of the parameter More... | |
| std::string | typeDescStr |
| a description of the type of the parameter: what type of values are allowed More... | |
| std::string | m_info |
| a basic information about the the parameter's purpose More... | |
| std::string | m_extInfo |
| an extended information about the the parameter's purpose More... | |
| bool | isRequired |
| a flag indicating if this parameter is required More... | |
| bool | requiredArg |
| a flag indicating if this parameter needs to be followed by a value More... | |
| bool | active |
| a flag indicating if this parameter is available More... | |
|
inline |
|
inlinevirtual |
Returns true if the parameter is filled, false otherwise.
Implements paramkit::Param.
|
inlinevirtual |
Parses the parameter from the given string.
Implements paramkit::Param.
Definition at line 404 of file param.h.
|
inlinevirtual |
Returns the string representation of the parameter's type.
Implements paramkit::Param.
|
inlinevirtual |
Returns the string representation of the parameter's value.
Implements paramkit::Param.
1.9.1