ImFusion SDK 4.3
FactoryBase Class Reference

#include <ImFusion/Base/FactoryBase.h>

Abstract base class for all factories. More...

+ Inheritance diagram for FactoryBase:

Detailed Description

Abstract base class for all factories.

Public Member Functions

 FactoryBase ()
 No license check is performed for the module instantiated with this constructor.
 
 FactoryBase (std::string module, bool checkLicense=true)
 
std::string moduleName () const
 Returns the module name of the factory.
 

Protected Member Functions

virtual ~FactoryBase ()
 Virtual destructor.
 
std::string getComponentPath (const std::string &componentName) const
 Returns the path to the component referred to by name.
 
bool isLicensed (const std::string &name)
 Return true if the license allows the use of the component referred to by name.
 

Static Protected Member Functions

static std::string getComponentPath (const std::string &moduleName, const std::string &componentName)
 Returns the path to the component referred to by name.
 
static bool isLicensed (const std::string &moduleName, const std::string &name)
 Return true if the license allows the use of the component referred to by name.
 

Protected Attributes

std::string m_factoryModule
 
bool m_checkLicense
 

Constructor & Destructor Documentation

◆ FactoryBase() [1/2]

No license check is performed for the module instantiated with this constructor.

Deprecated
"Use factory with a module name."

◆ FactoryBase() [2/2]

FactoryBase ( std::string module,
bool checkLicense = true )
explicit
Parameters
moduleThe module name of the factory.
checkLicenseIf true, the license is checked for the module.

Member Function Documentation

◆ getComponentPath() [1/2]

std::string getComponentPath ( const std::string & componentName) const
protected

Returns the path to the component referred to by name.

e.g. Reg.Sim.name

◆ getComponentPath() [2/2]

static std::string getComponentPath ( const std::string & moduleName,
const std::string & componentName )
staticprotected

Returns the path to the component referred to by name.

e.g. moduleName.name


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close