Static Public Member Functions | Private Member Functions | Static Private Member Functions | List of all members
ModuleVersionInfoInterface Class Reference

#include <moduleversioninfo.h>

Inheritance diagram for ModuleVersionInfoInterface:
Inheritance graph
[legend]

Detailed Description

The new ModuleVersionInfos Interface allows to register informations about external libraries/modules and their versions and maybe additional informations. The system automatically detects in which modules the library is used (see zip lib below). This will help in the future to track the used versions of external libs and their licenses.

Static Public Member Functions

static MAXON_FUNCTION Result< void > Register (const Id &uniqueId, const DataDictionary &moduleInfo)
 

Private Member Functions

 MAXON_INTERFACE (ModuleVersionInfoInterface, MAXON_REFERENCE_CONST, "net.maxon.interface.moduleversioninfo", MAXON_IMPLEMENTATION_MODULE("net.maxon.kernel"))
 

Static Private Member Functions

static MAXON_METHOD Result< void > RegisterIntern (const Id &uniqueId, const DataDictionary &moduleInfo, const ModuleInfo &info)
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( ModuleVersionInfoInterface  ,
MAXON_REFERENCE_CONST  ,
"net.maxon.interface.moduleversioninfo"  ,
MAXON_IMPLEMENTATION_MODULE("net.maxon.kernel")   
)
private

◆ RegisterIntern()

static MAXON_METHOD Result<void> RegisterIntern ( const Id &  uniqueId,
const DataDictionary &  moduleInfo,
const ModuleInfo &  info 
)
staticprivate

Register allow to add module version informations to the registry. This is for internal use only. Use Register instead.

Parameters
[in]uniqueIdUnique id of the module info. So if it is registered multiple twice because it's used within a header file it will collect the module dependencies for that module under this id.
[in]moduleInfoInformation to store. The dictionary should contains MODULEVERSIONINFO keys.
[in]infoModuleInfo provided by PRIVATE_MAXON_MODULE.
Returns
OK on success.

◆ Register()

static MAXON_FUNCTION Result<void> Register ( const Id &  uniqueId,
const DataDictionary &  moduleInfo 
)
static

Register allow to add module version informations to the registry.

Parameters
[in]uniqueIdUnique id of the module info. So if it is registered multiple twice because it's used within a header file it will collect the module dependencies for that module under this id.
[in]moduleInfoInformation to store. The dictionary should contains MODULEVERSIONINFO keys.
Returns
OK on success.