Struct IArgumentProvide#
Defined in File cmdlnparser.h
Inheritance Relationships#
Derived Type#
public CArgumentProvide< TArgument >(Template Class CArgumentProvide)
Struct Documentation#
-
struct IArgumentProvide#
Interface to generalize the access to argument implementation using virtual functions.
Remark
This interface contains only function prototypes.
Subclassed by CArgumentProvide< TArgument >
Public Functions
-
virtual void ArgumentAssign(const std::string &rssValue) = 0#
Assign the value from the string (override for assignment values)
- Parameters:
rssValue – [in] Reference to the string containing the value to be assigned.
-
virtual std::string GetArgumentOptionMarkup() = 0#
Get the markup string for the argument type. Overload in derived class.
- Returns:
std::string Returns the markup (default empty).
-
virtual std::string GetArgumentOptionDetails(size_t nMaxStringLen) = 0#
Get the option details for the argument type. Overload in derived class.
Remark
The nMaxStringLen could be ignored if no other alignment is needed; the print function will align the words based on their whitespace.
- Parameters:
nMaxStringLen – [in] The maximum length of the string in characters; after the length is reached a newline should be added.
- Returns:
std::string Returns the option details (default empty).
-
virtual std::string GetArgumentValueString() = 0#
Get the value of the variable.
- Returns:
std::string Returns the value of the variable.
-
virtual bool IsArgumentAssigned() = 0#
Is the argument assigned?
- Returns:
bool Returns ‘true’ when the argument was assigned; otherwise ‘false’.
-
virtual bool AllowMultiArgumentAssign() = 0#
Allow multi assignments?
- Returns:
bool Returns ‘true’ when multiple assignments are allowed; otherwise ‘false’.
-
virtual void ArgumentAssign(const std::string &rssValue) = 0#