FFaCmdLineEntryBase Class Reference

Abstract interface for command-line options. More...

#include <FFaCmdLineArg.H>

Inheritance diagram for FFaCmdLineEntryBase:

Public Member Functions
virtual	~FFaCmdLineEntryBase ()
	Empty destructor. More...
virtual bool	hasValue () const =0
	Checks if this option has been assigned a non-empty value. More...
virtual bool	hasDefault () const =0
	Checks if this option has been assigned a non-empty default value. More...
virtual int	convertOption (const std::string &)=0
	Converts the command-line option value from the given string. More...
virtual std::string	getDefaultString () const =0
	Composes the default section of the help text for this option. More...
virtual std::string	getValueString (bool=false) const =0
	Returns a string representation of the command-line option value. More...
virtual void	reset ()=0
	Resets the option to its default value. More...

Protected Member Functions
	FFaCmdLineEntryBase (const std::string &text, bool showToAll)
	The constructor initializes the class attributes. More...

Protected Attributes
std::string	myHelpText
	Text description of this command-line option. More...
bool	iAmSetOnCmdLine
	true if this option has been specified More...
bool	isPublic
	true unless this option is hidden More...

Friends
class	FFaCmdLineArg

Detailed Description

Abstract interface for command-line options.

Constructor & Destructor Documentation

FFaCmdLineEntryBase()

FFaCmdLineEntryBase::FFaCmdLineEntryBase ( const std::string &  text, bool  showToAll  )

inlineprotected

The constructor initializes the class attributes.

~FFaCmdLineEntryBase()

virtual FFaCmdLineEntryBase::~FFaCmdLineEntryBase ( )

inlinevirtual

Empty destructor.

Member Function Documentation

convertOption()

virtual int FFaCmdLineEntryBase::convertOption ( const std::string &  )

pure virtual

Converts the command-line option value from the given string.

Implemented in FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, and FFaCmdLineEntry< T >.

getDefaultString()

virtual std::string FFaCmdLineEntryBase::getDefaultString ( ) const

pure virtual

Composes the default section of the help text for this option.

Implemented in FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, and FFaCmdLineEntry< T >.

getValueString()

virtual std::string FFaCmdLineEntryBase::getValueString ( bool  = false ) const

pure virtual

Returns a string representation of the command-line option value.

Implemented in FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, and FFaCmdLineEntry< T >.

hasDefault()

virtual bool FFaCmdLineEntryBase::hasDefault ( ) const

pure virtual

Checks if this option has been assigned a non-empty default value.

Implemented in FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, FFaCmdLineEntry< T >, and FFaCmdLineEntry< T >.

hasValue()

virtual bool FFaCmdLineEntryBase::hasValue ( ) const

pure virtual

Checks if this option has been assigned a non-empty value.

Implemented in FFaCmdLineEntry< T >, and FFaCmdLineEntry< T >.

reset()

virtual void FFaCmdLineEntryBase::reset ( )

pure virtual

Resets the option to its default value.

Implemented in FFaCmdLineEntry< T >.

Friends And Related Function Documentation

FFaCmdLineArg

friend class FFaCmdLineArg

friend

Member Data Documentation

iAmSetOnCmdLine

bool FFaCmdLineEntryBase::iAmSetOnCmdLine

protected

true if this option has been specified

isPublic

bool FFaCmdLineEntryBase::isPublic

protected

true unless this option is hidden

myHelpText

std::string FFaCmdLineEntryBase::myHelpText

protected

Text description of this command-line option.

---

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

• fedem-foundation/src/FFaLib/FFaCmdLineArg/FFaCmdLineArg.H