helpType Class Reference

Base class for foam help classes. More...

Inheritance diagram for helpType:

Public Member Functions
	TypeName ("helpType")
	declareRunTimeSelectionTable (autoPtr, helpType, dictionary,(),())
	helpType ()=default
virtual	~helpType ()=default
virtual void	init ()
virtual void	execute (const argList &args, const fvMesh &mesh)=0

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

Protected Member Functions
fileName	doxygenPath () const
void	displayDocOptions (const string &searchStr, const bool exactMatch, const word &ext) const
void	displayDoc (const word &className, const string &searchStr, const bool exactMatch, const word &ext) const

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

~helpType()

virtual ~helpType ( )

virtualdefault

Member Function Documentation

doxygenPath()

fileName doxygenPath ( ) const

protected

displayDocOptions()

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

protected

displayDoc()

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

protected

TypeName()

TypeName

(

"helpType"

)

declareRunTimeSelectionTable()

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

New()

static autoPtr<helpType> New ( const word &  helpTypeName )

static

init()

virtual void init ( )

virtual

Reimplemented in helpBoundary, helpFunctionObject, and helpSolver.

execute()

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

pure virtual

Implemented in helpBoundary, helpFunctionObject, and helpSolver.

---

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

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