Face Engine SDK  5.25.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fsdk::ILicense Struct Referenceabstract

License objects interface. More...

#include <ILicense.h>

Inheritance diagram for fsdk::ILicense:
fsdk::IRefCounted

Public Member Functions

virtual ResultValue< FSDKError,
bool > 
checkFeatureId (LicenseFeature feature) const noexcept=0
 Checks if the feature with featureId is available in this license. More...
 
virtual ResultValue< FSDKError,
bool > 
isActivated () const noexcept=0
 Checks if current license object is activated and could be used by FaceEngine. More...
 
 FSDK_DEPRECATED ("loadFromFile is deprecated since v.5.5.0,"" Use loadFromFile(const char* path, const ISettingsProvider* settings) instead") virtual Result< FSDKError > loadFromFile(const char *path) noexcept=0
 Loads license from file. More...
 
virtual Result< FSDKErrorloadFromFile (const char *path, const ISettingsProvider *settings) noexcept=0
 Loads license from file. More...
 
virtual Result< FSDKErrorsaveToFile (const char *path) const noexcept=0
 Saves license as raw format to the file. This file could be used in the next run of the application. More...
 
virtual ResultValue< FSDKError,
uint32_t > 
getExpirationDate (LicenseFeature feature) const noexcept=0
 Gets license expiration date. More...
 
virtual Result< FSDKErrorgetLicenseType (int &licenseType) const noexcept=0
 Gets license type. More...
 
- Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t retain () noexcept=0
 Increase strong reference count. More...
 
virtual int32_t retainLocked () noexcept=0
 Increase strong reference count thread safely. More...
 
virtual int32_t release () noexcept=0
 Decrease strong reference count. More...
 
virtual int32_t getRefCount () const noexcept=0
 Get actual strong reference count. More...
 
virtual int32_t retainWeak () noexcept=0
 Increase weak reference count. More...
 
virtual int32_t releaseWeak () noexcept=0
 Decrease weak reference count. More...
 
virtual int32_t getWeakRefCount () const noexcept=0
 Get actual weak reference count. More...
 

Detailed Description

License objects interface.

Note
Use License objects to adopt FaceEngine functionality.

Member Function Documentation

virtual ResultValue<FSDKError, bool> fsdk::ILicense::checkFeatureId ( LicenseFeature  feature) const
pure virtualnoexcept

Checks if the feature with featureId is available in this license.

Parameters
[in]featureLicenseFeature type.
Returns
ResultValue with error code and true if feature is available, false if there is no such feature in this license or feature is expired or license was not activated.
See Also
LicenseFeature, ResultValue and FSDKError for details.
fsdk::ILicense::FSDK_DEPRECATED ( "loadFromFile is deprecated since v.5.5.  0,
""Use loadFromFile(const char *path, const ISettingsProvider *settings) instead"   
) const
pure virtualnoexcept

Loads license from file.

Parameters
[in]pathpath to the file.
Returns
Result with error code.
See Also
Result and FSDKError for details.
virtual ResultValue<FSDKError, uint32_t> fsdk::ILicense::getExpirationDate ( LicenseFeature  feature) const
pure virtualnoexcept

Gets license expiration date.

Parameters
[in]featureLicenseFeature type.
Returns
ResultValue with error code and uint32_t Unix Timestamp.
See Also
LicenseFeature, ResultValue and FSDKError for details.
Note
License settings should be set before using this method!
License should be activated before calling this method!
virtual Result<FSDKError> fsdk::ILicense::getLicenseType ( int &  licenseType) const
pure virtualnoexcept

Gets license type.

Parameters
[out]licenseType
Returns
Result with error code
See Also
LicenseType, ResultValue and FSDKError for details
virtual ResultValue<FSDKError, bool> fsdk::ILicense::isActivated ( ) const
pure virtualnoexcept

Checks if current license object is activated and could be used by FaceEngine.

Returns
ResultValue with error code and true if object is activated.
See Also
ResultValue and FSDKError for details.
Note
License object which was not activated could not be used because all features are disabled by default.
virtual Result<FSDKError> fsdk::ILicense::loadFromFile ( const char *  path,
const ISettingsProvider settings 
)
pure virtualnoexcept

Loads license from file.

Parameters
[in]pathpath to the file.
[in]settingsLicense settings provider.
Returns
Result with error code.
See Also
ISettingsProvider, Result and FSDKError for details.
virtual Result<FSDKError> fsdk::ILicense::saveToFile ( const char *  path) const
pure virtualnoexcept

Saves license as raw format to the file. This file could be used in the next run of the application.

Parameters
[in]pathpath to the file.
Returns
Result with error code.
See Also
Result and FSDKError for details.

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