oahOptionsUsageAtom Class Reference

Inheritance diagram for oahOptionsUsageAtom:

Public Member Functions
S_oahValuedAtom	handleOptionUnderName (string optionName, ostream &os)
virtual void	acceptIn (basevisitor *v)
virtual void	acceptOut (basevisitor *v)
virtual void	browseData (basevisitor *v)
void	print (ostream &os) const
void	printAtomOptionsValues (ostream &os, int valueFieldWidth) const
Public Member Functions inherited from oahAtom
void	setSubGroupUpLink (S_oahSubGroup subGroup)
S_oahSubGroup	getSubGroupUpLink () const
void	registerAtomInHandler (S_oahHandler handler)
virtual void	acceptIn (basevisitor *v)
virtual void	acceptOut (basevisitor *v)
virtual void	browseData (basevisitor *v)
void	print (ostream &os) const
virtual void	printAtomOptionsValues (ostream &os, int valueFieldWidth) const
Public Member Functions inherited from oahElement
void	setHandlerUpLink (S_oahHandler handlerUpLink)
S_oahHandler	getHandlerUpLink () const
string	getShortName () const
string	getLongName () const
string	getDescription () const
oahElementVisibilityKind	getElementVisibilityKind () const
void	setIsHidden ()
bool	getIsHidden () const
void	setMultipleOccurrencesAllowed ()
bool	getMultipleOccurrencesAllowed () const
string	fetchNames () const
string	fetchNamesInColumns (int subGroupsShortNameFieldWidth) const
string	fetchNamesBetweenParentheses () const
string	fetchNamesInColumnsBetweenParentheses (int subGroupsShortNameFieldWidth) const
virtual int	fetchVariableNameLength () const
S_oahElement	fetchOptionByName (string name)
virtual S_oahValuedAtom	handleOptionUnderName (string optionName, ostream &os)
virtual void	acceptIn (basevisitor *v)
virtual void	acceptOut (basevisitor *v)
virtual void	browseData (basevisitor *v)
virtual string	asShortNamedOptionString () const
virtual string	asActualLongNamedOptionString () const
string	asLongNamedOptionString () const
string	asString () const
virtual void	printOptionHeader (ostream &os) const
virtual void	printOptionEssentials (ostream &os, int fieldWidth) const
virtual void	print (ostream &os) const
virtual void	printHelp (ostream &os)
Public Member Functions inherited from smartable
unsigned	refs () const
	gives the reference count of the object
void	addReference ()
	addReference increments the ref count and checks for refCount overflow
void	removeReference ()
	removeReference delete the object when refCount is zero

Static Public Member Functions
static SMARTP< oahOptionsUsageAtom >	create (string shortName, string longName, string description)
Static Public Member Functions inherited from oahAtom
static SMARTP< oahAtom >	create (string shortName, string longName, string description)
Static Public Member Functions inherited from oahElement
static SMARTP< oahElement >	create (string shortName, string longName, string description, oahElementVisibilityKind optionVisibilityKind)

Protected Member Functions
	oahOptionsUsageAtom (string shortName, string longName, string description)
Protected Member Functions inherited from oahAtom
	oahAtom (string shortName, string longName, string description)
Protected Member Functions inherited from oahElement
	oahElement (string shortName, string longName, string description, oahElementVisibilityKind optionVisibilityKind)
Protected Member Functions inherited from smartable
	smartable (const smartable &)
virtual	~smartable ()
	destructor checks for non-zero refCount
smartable &	operator= (const smartable &)

Additional Inherited Members
Protected Attributes inherited from oahAtom
S_oahSubGroup	fSubGroupUpLink
Protected Attributes inherited from oahElement
S_oahHandler	fHandlerUpLink
string	fShortName
string	fLongName
string	fDescription
oahElementVisibilityKind	fElementVisibilityKind
bool	fIsHidden
bool	fMultipleOccurrencesAllowed

Member Function Documentation

acceptIn()

virtual void acceptIn ( basevisitor *  v )

virtual

Reimplemented from oahAtom.

acceptOut()

virtual void acceptOut ( basevisitor *  v )

virtual

Reimplemented from oahAtom.

browseData()

virtual void browseData ( basevisitor *  v )

virtual

Reimplemented from oahAtom.

handleOptionUnderName()

S_oahValuedAtom handleOptionUnderName ( string  optionName, ostream &  os  )

virtual

Reimplemented from oahElement.

print()

void print ( ostream &  os ) const

virtual

Reimplemented from oahAtom.

printAtomOptionsValues()

void printAtomOptionsValues ( ostream &  os, int  valueFieldWidth  ) const

virtual

Reimplemented from oahAtom.