#include <OptionsChrono.h>

Inheritance diagram for options::single< std::chrono::system_clock::time_point >:

Collaboration diagram for options::single< std::chrono::system_clock::time_point >:

Public Types
typedef rangeValueType	valueType

Public Types inherited from options::internal::typed_base< std::chrono::system_clock::time_point >
typedef std::chrono::system_clock::time_point	valueType

typedef std::conditional< std::is_same< std::chrono::system_clock::time_point, const char * >::value\|\|false, std::string, std::chrono::system_clock::time_point >::type	rangeValueType

typedef std::conditional< false, std::string, std::chrono::system_clock::time_point >::type	compareValueType

Public Types inherited from options::valuePrinter< std::chrono::system_clock::time_point >
typedef void(*	valuePrinterType) (std::ostream &, const std::chrono::system_clock::time_point &)

Public Member Functions
	single (char aShortName, const std::string &aLongName, const std::string &aExplanation, valueType aDefault=valueType::clock::now(), const std::vector< valueType > &aRange={}, valuePrinterType aValuePrinter=fDefaultValuePrinter)

	single (char aShortName, const std::string &aLongName, const std::string &aExplanation, const std::string &aDefault, const std::vector< std::string > &aRange={}, valuePrinterType aValuePrinter=fDefaultValuePrinter)

void	fAddDefaultFromStream (std::istream &aStream) override
	special for use in the shellScriptOptionParser More...

void	fWriteRange (std::ostream &aStream) 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::typed_base< std::chrono::system_clock::time_point >
	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...

virtual bool	fIsSet () const
	check if this option was set, regardless of from command line or config file More...

virtual bool	fIsContainer () const

const std::string &	fGetLongName () const
	returns long name of option, usually only for internal use. More...

Public Member Functions inherited from options::originalStringKeeper
void	fWriteOriginalString (std::ostream &aStream) const

const std::string &	fGetOriginalString () const

Public Member Functions inherited from options::valuePrinter< std::chrono::system_clock::time_point >
	valuePrinter ()

	valuePrinter (valuePrinterType aValuePrinter)

virtual void	fSetValuePrinter (valuePrinterType aValuePrinter)

Static Public Member Functions
static void	fDefaultValuePrinter (std::ostream &aStream, const valueType &aValue)

Protected Attributes
std::vector< valueType >	lRange

Protected Attributes inherited from options::internal::typed_base< std::chrono::system_clock::time_point >
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

Protected Attributes inherited from options::originalStringKeeper
std::string	lOriginalString

Protected Attributes inherited from options::valuePrinter< std::chrono::system_clock::time_point >
valuePrinterType	lValuePrinter

Additional Inherited Members
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	fWriteCfgLines (std::ostream &aStream, const char *aPrefix) const

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 ()

Detailed Description

Definition at line 68 of file OptionsChrono.h.

Member Typedef Documentation

◆ valueType

typedef rangeValueType options::single< std::chrono::system_clock::time_point >::valueType

Definition at line 74 of file OptionsChrono.h.

Constructor & Destructor Documentation

◆ single() [1/2]

options::single< std::chrono::system_clock::time_point >::single	(	char	aShortName,
		const std::string &	aLongName,
		const std::string &	aExplanation,
		valueType	aDefault = `valueType::clock::now()`,
		const std::vector< valueType > &	aRange = `{}`,
		valuePrinterType	aValuePrinter = `fDefaultValuePrinter`
	)

Definition at line 399 of file OptionsChrono.cpp.

                                                                                                                                                                                                                      :
         internal::typed_base<std::chrono::system_clock::time_point>(aShortName, aLongName, aExplanation, 1),
         valuePrinter(aValuePrinter) {
         *static_cast<valueType*>(this) = aDefault;
         if (!aRange.empty()) {
             fAddToRange(aRange);
         }
     }

References options::internal::typed_base< T >::fAddToRange().

Here is the call graph for this function:

◆ single() [2/2]

options::single< std::chrono::system_clock::time_point >::single	(	char	aShortName,
		const std::string &	aLongName,
		const std::string &	aExplanation,
		const std::string &	aDefault,
		const std::vector< std::string > &	aRange = `{}`,
		valuePrinterType	aValuePrinter = `fDefaultValuePrinter`
	)

Definition at line 407 of file OptionsChrono.cpp.

                                                                                                                                                                                                                             :
         internal::typed_base<std::chrono::system_clock::time_point>(aShortName, aLongName, aExplanation, 1),
         valuePrinter(aValuePrinter) {
         try {
             *static_cast<valueType*>(this) = internal::fParseTimePointString(aDefault);
         } catch (const std::runtime_error& e) {
             throw internal::optionError(this, e.what());
         }
         lOriginalString = aDefault;
         if (!aRange.empty()) {
             fAddToRange(aRange);
         }
     }

References options::internal::typed_base< T >::fAddToRange(), and options::internal::fParseTimePointString().

Here is the call graph for this function:

Member Function Documentation

◆ fAddDefaultFromStream()

void options::single< std::chrono::system_clock::time_point >::fAddDefaultFromStream ( std::istream & aStream )

overridevirtual

special for use in the shellScriptOptionParser

read a value from aStram and set that as default

Implements options::base.

Definition at line 421 of file OptionsChrono.cpp.

                                                                                            {
         std::getline(aStream, lOriginalString);
         try {
             *static_cast<valueType*>(this) = internal::fParseTimePointString(lOriginalString);
         } catch (const std::runtime_error& e) {
             throw internal::optionError(this, e.what());
         }
     }

References options::internal::fParseTimePointString().

Here is the call graph for this function:

◆ fCheckRange()

void options::single< std::chrono::system_clock::time_point >::fCheckRange ( ) const

inlineoverridevirtual

Implements options::base.

Definition at line 89 of file OptionsChrono.h.

                                           {
             this->fCheckValueForRange(*this);
         }

References options::internal::typed_base< T >::fCheckValueForRange().

Here is the call graph for this function:

◆ fDefaultValuePrinter()

void options::single< std::chrono::system_clock::time_point >::fDefaultValuePrinter	(	std::ostream &	aStream,
		const valueType &	aValue
	)

static

Definition at line 393 of file OptionsChrono.cpp.

                                                                                                                    {
         auto flags(aStream.flags());
         aStream << std::fixed;
         aStream << std::chrono::duration<double>(aValue.time_since_epoch()).count();
         aStream.flags(flags);
     }

◆ fSetMe()

void options::single< std::chrono::system_clock::time_point >::fSetMe	(	std::istream &	aStream,
		const internal::sourceItem &	aSource
	)

overridevirtual

function to set the value from a string, remembering the source

Implements options::base.

Definition at line 452 of file OptionsChrono.cpp.

                                                                                                                {
         using escapedIO::operator>>;
         aStream >> lOriginalString;
         try {
             *static_cast<valueType*>(this) = internal::fParseTimePointString(lOriginalString);
         } catch (const std::runtime_error& e) {
             throw internal::optionError(this, e.what());
         }
         fSetSource(aSource);
     }

References options::internal::fParseTimePointString(), and options::base::fSetSource().

Here is the call graph for this function:

◆ fWriteRange()

void options::single< std::chrono::system_clock::time_point >::fWriteRange ( std::ostream & aStream ) const

overridevirtual

Reimplemented from options::base.

Definition at line 430 of file OptionsChrono.cpp.

                                                                                        {
         if (! lRange.empty()) {
             aStream << "# allowed range is";
             if (lRange.size() == 2) {
                 aStream << " [";
                 lValuePrinter(aStream, lRange[0]);
                 aStream << ", ";
                 lValuePrinter(aStream, lRange[1]);
                 aStream << "]\n";
             } else {
                 for (auto& rangeElement : lRange) {
                     lValuePrinter(aStream, rangeElement);
                     aStream << "\n";
                 }
                 aStream << "\n";
             }
         }
     }

References options::internal::typed_base< T >::lRange.

◆ fWriteValue()

void options::single< std::chrono::system_clock::time_point >::fWriteValue ( std::ostream & aStream ) const

overridevirtual

write textual representation of value to a std::ostream

Implements options::base.

Definition at line 449 of file OptionsChrono.cpp.

                                                                                        {
         lValuePrinter(aStream, *this);
     }

Referenced by main().

Here is the caller graph for this function:

Member Data Documentation

◆ lRange

std::vector<valueType> options::single< std::chrono::system_clock::time_point >::lRange

protected

Definition at line 76 of file OptionsChrono.h.

The documentation for this class was generated from the following files:

OptionParser/src/include/OptionsChrono.h (v0.19-24-g0617ca1 with changes)
OptionParser/src/OptionsChrono.cpp (v0.19-24-g0617ca1 with changes)

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ valueType

Constructor & Destructor Documentation

◆ single() [1/2]

◆ single() [2/2]

Member Function Documentation

◆ fAddDefaultFromStream()

◆ fCheckRange()

◆ fDefaultValuePrinter()

◆ fSetMe()

◆ fWriteRange()

◆ fWriteValue()

Member Data Documentation

◆ lRange