NeoFOAM::BaseClassDocumentation Class Reference

Provides a mechanism for registering and retrieving documentation for base and derived classes. More...

#include <runtimeSelectionFactory.hpp>

Public Types
using	LookupTable = std::unordered_map< std::string, BaseClassData >

Static Public Member Functions
static void	registerClass (std::string name, BaseClassData data)
static std::string	doc (const std::string &baseClassName, const std::string &derivedClassName)
static std::string	schema (const std::string &baseClassName, const std::string &derivedClassName)
static std::vector< std::string >	entries (const std::string &baseClassName)
static LookupTable &	docTable ()

Detailed Description

Provides a mechanism for registering and retrieving documentation for base and derived classes.

The BaseClassDocumentation class allows users to register documentation for base classes and retrieve documentation for derived classes based on the registered information. It also provides methods to retrieve the schema and entries associated with a base class.

Definition at line 53 of file runtimeSelectionFactory.hpp.

Member Typedef Documentation

LookupTable

using NeoFOAM::BaseClassDocumentation::LookupTable = std::unordered_map<std::string, BaseClassData>

Definition at line 57 of file runtimeSelectionFactory.hpp.

Member Function Documentation

doc()

static std::string NeoFOAM::BaseClassDocumentation::doc ( const std::string &  baseClassName, const std::string &  derivedClassName  )

inlinestatic

Returns the documentation for a derived class based on the base class name.

Parameters

baseClassName	The name of the base class.
derivedClassName	The name of the derived class.

Returns

The documentation for the derived class.

Definition at line 72 of file runtimeSelectionFactory.hpp.

docTable()

static LookupTable & NeoFOAM::BaseClassDocumentation::docTable ( )

inlinestatic

Definition at line 101 of file runtimeSelectionFactory.hpp.

entries()

static std::vector< std::string > NeoFOAM::BaseClassDocumentation::entries ( const std::string &  baseClassName )

inlinestatic

Returns a vector of strings representing the entries for a given base class name.

Parameters

baseClassName

The name of the base class.

Returns

A vector of strings representing the entries.

Definition at line 96 of file runtimeSelectionFactory.hpp.

registerClass()

static void NeoFOAM::BaseClassDocumentation::registerClass ( std::string  name, BaseClassData  data  )

inlinestatic

Definition at line 59 of file runtimeSelectionFactory.hpp.

schema()

static std::string NeoFOAM::BaseClassDocumentation::schema ( const std::string &  baseClassName, const std::string &  derivedClassName  )

inlinestatic

Returns the schema of the derived class based on the base class name and derived class name.

Parameters

baseClassName	The name of the base class.
derivedClassName	The name of the derived class.

Returns

The schema of the derived class.

Definition at line 84 of file runtimeSelectionFactory.hpp.

---

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

• /home/runner/work/NeoFOAM/NeoFOAM/include/NeoFOAM/core/runtimeSelectionFactory.hpp