Kanzi  3.9.6
Kanzi Engine API
kanzi::Module Class Reference

Module is a class representing a functional module with its own metadata about the types it contains. More...

#include <kanzi/core/module/module.hpp>

Inheritance diagram for kanzi::Module:
[legend]

Public Types

typedef vector< const Metaclass * > MetaclassContainer
 
typedef MetaclassContainer::iterator MetaclassIterator
 

Public Member Functions

virtual void destroy ()
 
virtual MetaclassContainer getMetaclassesOverride ()
 
 Module ()
 
virtual void registerDebugRenderingFunctions (DebugRenderRegistry &)
 Register the module debug rendering functions. More...
 
virtual void registerMetadataOverride (ObjectFactory &)
 Register the rest of module metadata, such as loaders for types in module. More...
 
void setDomain (Domain *domain)
 Set the domain. More...
 

Protected Member Functions

virtual ~Module ()=default
 Destructor. More...
 

Protected Attributes

Domainm_domain
 The domain this module is registered to. More...
 

Detailed Description

Module is a class representing a functional module with its own metadata about the types it contains.

Member Typedef Documentation

◆ MetaclassContainer

◆ MetaclassIterator

typedef MetaclassContainer::iterator kanzi::Module::MetaclassIterator

Constructor & Destructor Documentation

◆ Module()

kanzi::Module::Module ( )
inlineexplicit

◆ ~Module()

virtual kanzi::Module::~Module ( )
protectedvirtualdefault

Destructor.

Member Function Documentation

◆ getMetaclassesOverride()

virtual MetaclassContainer kanzi::Module::getMetaclassesOverride ( )
inlinevirtual

Reimplemented in kanzi::KanziComponentsModule.

◆ destroy()

virtual void kanzi::Module::destroy ( )
inlinevirtual

◆ registerMetadataOverride()

virtual void kanzi::Module::registerMetadataOverride ( ObjectFactory )
inlinevirtual

Register the rest of module metadata, such as loaders for types in module.

When registering a module, a domain calls this function.

Reimplemented in kanzi::ExampleApplication, kanzi::JavaModule, and kanzi::JvmModule.

◆ registerDebugRenderingFunctions()

virtual void kanzi::Module::registerDebugRenderingFunctions ( DebugRenderRegistry )
inlinevirtual

Register the module debug rendering functions.

When registering a module, a domain calls this function.

◆ setDomain()

void kanzi::Module::setDomain ( Domain domain)
inline

Set the domain.

When registering a module, a domain calls this function.

Member Data Documentation

◆ m_domain

Domain* kanzi::Module::m_domain
protected

The domain this module is registered to.


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