PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Lm::Services::ILicenseStatusService Class Referenceabstract

Service methods retrieving current license status More...

#include <ILicenseStatusService.hpp>

Inheritance diagram for Arp::System::Lm::Services::ILicenseStatusService:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< ILicenseStatusService >
 
- Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using Ptr = std::shared_ptr< IRscService >
 The shared_ptr type of IRscService.
 

Public Member Functions

 ILicenseStatusService (void)=default
 Constructs an ILicenseStatusService instance.
 
virtual boolean GetLicenseStatus (uint32 firmCode, uint32 productCode, uint32 featureCode=0)=0
 Retrieves license status of specified firm code, product code and feature code provide by license issuer More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
 IRscService (void)=default
 The default constructor.
 
 IRscService (const IRscService &arg)=delete
 The deleted copy constructor. More...
 
 IRscService (IRscService &&arg) noexcept=default
 The default move constructor. More...
 
IRscServiceoperator= (const IRscService &arg)=delete
 The deleted assignment operator. More...
 
IRscServiceoperator= (IRscService &&arg) noexcept=default
 The default move-assignment operator. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resources.
 

Static Public Member Functions

static IRscServiceProxyFactoryGetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactoryGetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of this service. More...
 

Detailed Description

Service methods retrieving current license status

This service is defined in library Arp.System.Lm.Services.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

◆ GetLicenseStatus()

virtual boolean Arp::System::Lm::Services::ILicenseStatusService::GetLicenseStatus ( uint32  firmCode,
uint32  productCode,
uint32  featureCode = 0 
)
pure virtual

Retrieves license status of specified firm code, product code and feature code provide by license issuer

Parameters
firmCodeFirm code
productCodeProduct code
featureCodeFeature code (ignored if 0)
Returns
true, if license is valid, false if license is invalid
Exceptions
System.InvalidOperationException"License manager has not been configured."

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