 |
Plasma Engine
2.0
|
|
Plasma Engine
2.0
|
An 'enum' option is a string option that only allows certain phrases ('keys'). More...
#include <CommandLineOptions.h>
Classes | |
| struct | EnumKeyValue |
Public Member Functions | |
| plCommandLineOptionEnum (plStringView sSortingGroup, plStringView sArgument, plStringView sLongDesc, plStringView sEnumKeysAndValues, plInt32 iDefaultValue, bool bCaseSensitive=false) | |
| plInt32 | GetOptionValue (LogMode logMode, const plCommandLineUtils *pUtils=plCommandLineUtils::GetGlobalInstance()) const |
| Returns the value of this option. Either what was specified on the command line, or the default value. | |
| virtual void | GetParamShortDesc (plStringBuilder &ref_sOut) const override |
| Returns a very short description of the option (type). For example "<int>" or "<enum>". | |
| virtual void | GetParamDefaultValueDesc (plStringBuilder &ref_sOut) const override |
| Returns a very short string for the options default value. For example "0" or "auto". | |
| void | GetEnumKeysAndValues (plDynamicArray< EnumKeyValue > &out_keysAndValues) const |
| Returns the enum keys (names) and values (integers) extracted from the string that was passed to the constructor. | |
| void | SetDefaultValue (plInt32 value) |
| Modifies the default value. | |
| plInt32 | GetDefaultValue () const |
| Returns the default value. | |
| virtual plStringView | GetType () override |
| Returns "Enum". | |
 Public Member Functions inherited from plCommandLineOptionDoc | |
| plCommandLineOptionDoc (plStringView sSortingGroup, plStringView sArgument, plStringView sParamShortDesc, plStringView sLongDesc, plStringView sDefaultValue, bool bCaseSensitive=false) | |
| virtual void | GetOptions (plStringBuilder &ref_sOut) const override |
| Writes all the supported options (e.g. '-arg') to 'out'. If more than one option is allowed, they should be separated with semicolons or pipes. | |
| virtual void | GetLongDesc (plStringBuilder &ref_sOut) const override |
| Returns a proper description of the option. | |
| bool | IsOptionSpecified (plStringBuilder *out_pWhich=nullptr, const plCommandLineUtils *pUtils=plCommandLineUtils::GetGlobalInstance()) const |
| Checks whether any of the option variants is set on the command line, and returns which one. For example '-h' or '-help'. | |
| Public Member Functions inherited from plCommandLineOption | |
| plCommandLineOption (plStringView sSortingGroup) | |
| virtual void | GetSortingGroup (plStringBuilder &ref_sOut) const |
| Writes the sorting group name to 'out'. | |
| void | GetSplitOptions (plStringBuilder &out_sAll, plDynamicArray< plStringView > &ref_splitOptions) const |
| Returns the supported option names (e.g. '-arg') as split strings. | |
Protected Attributes | |
| plInt32 | m_iDefaultValue = 0 |
| plStringView | m_sEnumKeysAndValues |
| Protected Attributes inherited from plCommandLineOptionDoc | |
| plStringView | m_sArgument |
| plStringView | m_sParamShortDesc |
| plStringView | m_sParamDefaultValue |
| plStringView | m_sLongDesc |
| bool | m_bCaseSensitive = false |
| bool | m_bLoggedOnce = false |
| Protected Attributes inherited from plCommandLineOption | |
| plStringView | m_sSortingGroup |
| Protected Attributes inherited from plEnumerable< plCommandLineOption > | |
| plEnumerable * | m_pNextInstance |
Additional Inherited Members | |
| Public Types inherited from plCommandLineOption | |
| enum class | LogAvailableModes { Always , IfHelpRequested } |
| enum class | LogMode { Never , FirstTime , FirstTimeIfSpecified , Always , AlwaysIfSpecified } |
| Describes whether the value of an option (and whether something went wrong), should be printed to plLog. More... | |
| Static Public Member Functions inherited from plCommandLineOption | |
| static bool | IsHelpRequested (const plCommandLineUtils *pUtils=plCommandLineUtils::GetGlobalInstance()) |
| Checks whether a command line was passed that requests help output. | |
| static plResult | RequireOptions (plStringView sRequiredOptions, plString *pMissingOption=nullptr, const plCommandLineUtils *pUtils=plCommandLineUtils::GetGlobalInstance()) |
| Checks whether all required options are passed to the command line. | |
| static bool | LogAvailableOptions (LogAvailableModes mode, plStringView sGroupFilter={}, const plCommandLineUtils *pUtils=plCommandLineUtils::GetGlobalInstance()) |
| Prints all available options to the plLog. | |
| static bool | LogAvailableOptionsToBuffer (plStringBuilder &out_sBuffer, LogAvailableModes mode, plStringView sGroupFilter={}, const plCommandLineUtils *pUtils=plCommandLineUtils::GetGlobalInstance()) |
| Same as LogAvailableOptions() but captures the output from plLog and returns it in an plStringBuilder. | |
| Static Public Member Functions inherited from plNoBase | |
| static const plRTTI * | GetStaticRTTI () |
| Protected Member Functions inherited from plCommandLineOptionDoc | |
| bool | ShouldLog (LogMode mode, bool bWasSpecified) const |
| void | LogOption (plStringView sOption, plStringView sValue, bool bWasSpecified) const |
An 'enum' option is a string option that only allows certain phrases ('keys').
Each phrase has an integer value, and GetOptionValue() returns the integer value of the selected phrase. It is valid for the default value to be different from all the phrase values, which can be used to detect whether the user provided any phrase at all.
The allowed values are passed in as a single string, in the form "OptA = 0 | OptB = 1 | ..." Phrase values ("= 0" etc) are optional, and if not given are automatically assigned starting at zero. Multiple phrases may share the same value.
|
overridevirtual |
Returns a very short string for the options default value. For example "0" or "auto".
Reimplemented from plCommandLineOptionDoc.
|
overridevirtual |
Returns a very short description of the option (type). For example "<int>" or "<enum>".
Reimplemented from plCommandLineOptionDoc.
|
inlineoverridevirtual |
Returns "Enum".
Reimplemented from plCommandLineOptionDoc.
1.11.0