 |
ewmscp
..
|
|
ewmscp
..
|
This class is an intermediate helper class for options that are map-based. More...
#include <Options.h>
Public Member Functions | |
| baseForMap (char aShortName, std::string aLongName, std::string aExplanation, short aNargs) | |
| void | fAddSource (const T *aValueLocation, const internal::sourceItem &aSource) |
| const internal::sourceItem | fGetSource (const T *aValueLocation) const |
| bool | fIsSet () const override |
| check if this option was set, regardless of from command line or config file More... | |
| bool | fIsContainer () const override |
| void | fAddDefaultFromStream (std::istream &aStream) override |
| special for use in the shellScriptOptionParser More... | |
 Public Member Functions inherited from options::internal::typed_base< T > | |
| typed_base (Types ... args) | |
| virtual void | fAddToRange (rangeValueType aValue) |
| add a value to the range of allowed values More... | |
| std::enable_if<(!std::is_same< rangeValueType, std::string >::value) &&std::is_same< TT, std::string >::value, void >::type | fAddToRange (const TT &aString) |
| void | fAddToRange (InputIt aBegin, InputIt aEnd) |
| add values from the iterator range [aBegin,aEnd) to the range of allowed values More... | |
| void | fAddToRange (const std::vector< TT > &aRange) |
| add values from a vector (may be given as initializer list) to the range of allowed values More... | |
| void | fAddToRangeFromStream (std::istream &aStream) override |
| void | fWriteRange (std::ostream &aStream) const override |
| virtual void | fCheckValueForRange (const compareValueType &aValue) const |
| Public Member Functions inherited from options::base | |
| base (char aShortName, const std::string &aLongName, const std::string &aExplanation, short aNargs) | |
| construct an object of type base More... | |
| virtual | ~base () |
| virtual void | fWriteValue (std::ostream &aStream) const =0 |
| write textual representation of value to a std::ostream More... | |
| virtual void | fRequire (const base *aOtherOption) |
| require aOtherOption when this option is set More... | |
| virtual void | fRequire (std::vector< const base * > aOtherOptions) |
| add vector of other options, particlularly nice for use with initializer list More... | |
| template<typename InputIt > | |
| void | fRequire (InputIt aBegin, InputIt aEnd) |
| add all options from the pair of iterators [aBegin,aEnd) to the list of required options More... | |
| virtual void | fForbid (const base *aOtherOption) |
| forbid aOtherOption when this option is set More... | |
| virtual void | fForbid (std::vector< const base * > aOtherOptions) |
| add vector of other options, particlularly nice for use with initializer list More... | |
| template<typename InputIt > | |
| void | fForbid (InputIt aBegin, InputIt aEnd) |
| add all options from the pair of iterators [aBegin,aEnd) to the list of forbidden options More... | |
| const std::string & | fGetLongName () const |
| returns long name of option, usually only for internal use. More... | |
Protected Attributes | |
| std::map< const T *, const internal::sourceItem > | lSources |
| Protected Attributes inherited from options::internal::typed_base< T > | |
| std::multiset< rangeValueType > | lRange |
| Protected Attributes inherited from options::base | |
| char | lShortName |
| const std::string | lLongName |
| const std::string | lExplanation |
| internal::sourceItem | lSource |
| short | lNargs |
| bool | lHidden |
| std::vector< std::string > * | lPreserveWorthyStuff |
| std::vector< const base * > | lRequiredOptions |
| std::vector< const base * > | lForbiddenOptions |
Additional Inherited Members | |
| Public Types inherited from options::internal::typed_base< T > | |
| typedef T | valueType |
| typedef std::conditional< std::is_same< T, const char * >::value||false, std::string, T >::type | rangeValueType |
| typedef std::conditional< false, std::string, T >::type | compareValueType |
| Protected Member Functions inherited from options::base | |
| virtual void | fSetMe (std::istream &aStream, const internal::sourceItem &aSource)=0 |
| function to set the value from a string, remembering the source More... | |
| virtual void | fSetMeNoarg (const internal::sourceItem &) |
| virtual void | fSetSource (const internal::sourceItem &aSource) |
| remember the source that provided the value, e.g. commandline or a config file More... | |
| virtual void | fWriteCfgLines (std::ostream &aStream, const char *aPrefix) const |
| virtual void | fCheckRange () const =0 |
| void | fSetPreserveWorthyStuff (std::vector< std::string > *aStuff) |
| void | fHide () |
| hide option, will be respected by help More... | |
| bool | fIsHidden () const |
| void | fDisable () |
| disable option by removing it from the maps More... | |
| Static Protected Member Functions inherited from options::base | |
| static std::map< std::string, base * > & | fGetOptionMap () |
| static std::map< char, base * > & | fGetShortOptionMap () |
This class is an intermediate helper class for options that are map-based.
It is not to be used directly.
|
inline |
|
inlineoverridevirtual |
special for use in the shellScriptOptionParser
read a value from aStram and set that as default
Implements options::base.
Definition at line 656 of file Options.h.
|
inline |
Definition at line 639 of file Options.h.
Referenced by options::map< T >::fSetMe().
|
inline |
Definition at line 642 of file Options.h.
Referenced by options::map< T >::fWriteCfgLines().
|
inlineoverridevirtual |
Reimplemented from options::base.
|
inlineoverridevirtual |
check if this option was set, regardless of from command line or config file
Reimplemented from options::base.
|
protected |
Definition at line 635 of file Options.h.
Referenced by options::internal::baseForMap< std::string >::fAddSource(), options::internal::baseForMap< std::string >::fGetSource(), and options::internal::baseForMap< std::string >::fIsSet().
1.8.17