ewmscp  ..
Public Member Functions | List of all members
arrayOption< T > Class Template Reference
Inheritance diagram for arrayOption< T >:
[legend]
Collaboration diagram for arrayOption< T >:
[legend]

Public Member Functions

template<class ... Types>
 arrayOption (Types ... args)
 
void fWriteValue (std::ostream &aStream) const override
 write textual representation of value to a std::ostream More...
 
- Public Member Functions inherited from options::container< T >
 container (char aShortName, const std::string &aLongName, const std::string &aExplanation, std::initializer_list< typename std::vector< T > ::value_type > aDefault={})
 
 container (const container &)=delete
 
void fWriteCfgLines (std::ostream &aStream, const char *aPrefix) const override
 
void fWriteValue (std::ostream &aStream) const override
 write textual representation of value to a std::ostream More...
 
void fSetMe (std::istream &aStream, const internal::sourceItem &aSource) override
 function to set the value from a string, remembering the source More...
 
void fCheckRange () const override
 
- Public Member Functions inherited from options::internal::baseForContainer< T >
 baseForContainer (char aShortName, std::string aLongName, std::string aExplanation, short aNargs)
 
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 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...
 

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 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 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 ()
 
- Protected Attributes inherited from options::internal::baseForContainer< T >
std::vector< internal::sourceItemlSources
 
- Protected Attributes inherited from options::internal::typed_base< T >
std::multiset< rangeValueTypelRange
 
- 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
 

Detailed Description

template<typename T>
class arrayOption< T >

Definition at line 24 of file shellScriptOptionParser.cpp.

Constructor & Destructor Documentation

◆ arrayOption()

template<typename T >
template<class ... Types>
arrayOption< T >::arrayOption ( Types ...  args)
inline

Definition at line 26 of file shellScriptOptionParser.cpp.

26  :
27  options::container<T>(args...) {
28  };

Member Function Documentation

◆ fWriteValue()

template<typename T >
void arrayOption< T >::fWriteValue ( std::ostream &  aStream) const
inlineoverridevirtual

write textual representation of value to a std::ostream

Implements options::base.

Definition at line 29 of file shellScriptOptionParser.cpp.

29  {
30  aStream << "(";
31  for (const auto& item : *this) {
32  aStream << ' ';
33  using options::escapedIO::operator<<;
34  aStream << item;
35  }
36  aStream << ")";
37  };

The documentation for this class was generated from the following file:
options::container< T >