helpType Class Reference

Base class for foam help classes. More...

#include <helpType.H>

Inheritance diagram for helpType:

Public Member Functions
	TypeName ("helpType")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),())
	helpType ()=default
	Default construct.
virtual	~helpType ()=default
	Destructor.
virtual void	init ()
	Initialise - typically setting static variables,.
virtual void	execute (const argList &args, const fvMesh &mesh)=0
	Execute the help.

Static Public Member Functions
static autoPtr< helpType >	New (const word &helpTypeName)
	Selector.

Protected Member Functions
fileName	doxygenPath () const
	Return file path to the Doxygen sources (if available).
void	displayDocOptions (const string &searchStr, const bool exactMatch, const word &ext) const
	Display the list of documentation options.
void	displayDoc (const word &className, const string &searchStr, const bool exactMatch, const word &ext) const
	Display the help documentation in a browser.

Detailed Description

Base class for foam help classes.

Source files

• helpType.H
• helpType.C
• helpTypeNew.C

Definition at line 52 of file helpType.H.

Constructor & Destructor Documentation

helpType()

helpType ( )

default

Default construct.

Referenced by declareRunTimeSelectionTable().

Here is the caller graph for this function:

~helpType()

virtual ~helpType ( )

virtualdefault

Destructor.

Member Function Documentation

doxygenPath()

fileName doxygenPath ( ) const

protected

Return file path to the Doxygen sources (if available).

displayDocOptions()

void displayDocOptions ( const string & searchStr, const bool exactMatch, const word & ext ) const

protected

Display the list of documentation options.

displayDoc()

void displayDoc ( const word & className, const string & searchStr, const bool exactMatch, const word & ext ) const

protected

Display the help documentation in a browser.

TypeName()

TypeName

(

"helpType"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		helpType	,
		dictionary	,
		()	,
		()	)

References helpType().

Here is the call graph for this function:

New()

autoPtr< helpType > New ( const word & helpTypeName )

static

Selector.

init()

virtual void init ( )

virtual

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented in helpBoundary, helpFunctionObject, and helpSolver.

execute()

virtual void execute ( const argList & args, const fvMesh & mesh )

pure virtual

Execute the help.

Implemented in helpBoundary, helpFunctionObject, and helpSolver.

References args, and mesh.

---

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

• applications/utilities/miscellaneous/foamHelp/helpTypes/helpType/helpType.H