ILicensedComponent is an optional side interface for components that require license validation.
More...
#include <hydrocouple.h>
ILicensedComponent is an optional side interface for components that require license validation.
Licensing was removed from IComponentInfo so that headless HPC and cloud builds need not implement licensing stubs. Components that require licensing implement this interface and advertise Capability::Licensing.
◆ ~ILicensedComponent()
| virtual HydroCouple::ILicensedComponent::~ILicensedComponent |
( |
| ) |
|
|
virtualdefault |
◆ validateLicense() [1/2]
| virtual bool HydroCouple::ILicensedComponent::validateLicense |
( |
const std::string & | licenseInfo, |
|
|
std::string & | validationMessage ) |
|
nodiscardpure virtual |
Checks if license is valid and persists license information.
Developer is responsible for implementing this validation based on a license.
- Parameters
-
| [in] | licenseInfo | license information to use to register this component. |
| [out] | validationMessage | A validation message associated with the license validation process. |
- Returns
- true if license is valid otherwise false.
◆ validateLicense() [2/2]
| virtual bool HydroCouple::ILicensedComponent::validateLicense |
( |
std::string & | validationMessage | ) |
|
|
nodiscardpure virtual |
validateLicense Checks if component is licensed and returns.
- Parameters
-
| [out] | validationMessage | A validation message associated with the license validation process. |
- Returns
- true if component is licensed otherwise false.
The documentation for this class was generated from the following file: