Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
helpType Class Referenceabstract

Base class for foam help classes. More...

Inheritance diagram for helpType:
[legend]

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

Base class for foam help classes.

Source files

Definition at line 56 of file helpType.H.

Constructor & Destructor Documentation

◆ helpType()

helpType ( )
default

Default construct.

◆ ~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  ,
()  ,
()   
)

◆ New()

static 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.

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