Class ModuleInfo is used to describe module properties at runtime. More...
#include <moduleinfo.h>
Inheritance diagram for crp::ModuleInfo:
Public Member Functions | |
| ModuleInfo () | |
| Creates a new module info. | |
| ModuleInfo (const XMLDataPool &module_info) | |
| Creates a new module info from a data pool. | |
| ~ModuleInfo () | |
| Releases information. | |
| std::string | get_module_name () |
| Returns the name of the module. | |
| std::string | get_module_type () |
| Returns the type of the module. | |
| bool | is_function () |
| Returns true if the module is a pure function. | |
| std::vector< std::string > | get_functions () |
| Returns the functions of the module. | |
| std::string | get_brief_info (const std::string &key) |
| Returns the brief information of the function with the given key. | |
| std::string | get_description () |
| Returns a short description of the module in rich text format. | |
| std::string | get_function_description (const std::string &key) |
| Creates a description of a function. | |
| std::string | get_function_signature (const std::string &key) |
| Returns the function signature. | |
Detailed Description
Class ModuleInfo is used to describe module properties at runtime.
Constructor & Destructor Documentation
| crp::ModuleInfo::ModuleInfo | ( | ) |
Creates a new module info.
| crp::ModuleInfo::ModuleInfo | ( | const XMLDataPool & | module_info | ) |
Creates a new module info from a data pool.
- Parameters:
-
module_info A copy of the module info
| crp::ModuleInfo::~ModuleInfo | ( | ) |
Releases information.
Member Function Documentation
| std::string crp::ModuleInfo::get_brief_info | ( | const std::string & | key | ) |
Returns the brief information of the function with the given key.
- Parameters:
-
key Key to the function
- Returns:
- Brief description
| std::string crp::ModuleInfo::get_description | ( | ) |
Returns a short description of the module in rich text format.
- Returns:
- Module description
| std::string crp::ModuleInfo::get_function_description | ( | const std::string & | key | ) |
Creates a description of a function.
- Parameters:
-
key Key to the function
- Returns:
- Function description
| std::string crp::ModuleInfo::get_function_signature | ( | const std::string & | key | ) |
| std::vector<std::string> crp::ModuleInfo::get_functions | ( | ) |
Returns the functions of the module.
- Returns:
- List of functions which can be called on the instance of the module.
| std::string crp::ModuleInfo::get_module_name | ( | ) |
Returns the name of the module.
- Returns:
- Name of the module
| std::string crp::ModuleInfo::get_module_type | ( | ) |
Returns the type of the module.
- Returns:
- Type of the module
| bool crp::ModuleInfo::is_function | ( | ) |
Returns true if the module is a pure function.
Otherwise the module is a class.
- Returns:
- True if the module is a function
The documentation for this class was generated from the following file:
