The LicenseFeature class represents device functionality that is enabled with a valid license. More...

#include <LicenseFeature.h>

Public Member Functions
	LicenseFeature (VxSdk::IVxLicenseFeature *vxLicenseFeature)
	Constructor. More...

virtual	~LicenseFeature ()
	Destructor. More...

	!LicenseFeature ()
	Finaliser. More...

Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
System::Collections::Generic::List< Device^ >^	_GetCommissionedDevices ()

Package Attributes
VxSdk::IVxLicenseFeature *	_licenseFeature

Properties
System::String^	ActivationId `[get]`
	Gets the activation identifier. More...

System::Collections::Generic::List< Device^ >^	CommissionedDevices `[get]`
	Gets the devices that have been commissioned for this feature. More...

int	Count `[get]`
	Gets the allowable commisions count. More...

System::DateTime	Expiration `[get]`
	Gets the date and time at which the feature will expire. More...

System::String^	Id `[get]`
	Gets the unique identifier of the feature. More...

System::DateTime	Installation `[get]`
	Gets the date and time at which the feature was installed on the host. More...

bool	IsPending `[get]`
	Gets a value indicating whether this is a "pending" feature, which does not enable any device functionality, or a normal feature that does. More...

System::String^	Name `[get]`
	Gets the name of the feature. More...

int	Used `[get]`
	Gets the amount of the allowable count that is currently used by commissions. More...

System::String^	Version `[get]`
	Gets the feature version. More...

Detailed Description

The LicenseFeature class represents device functionality that is enabled with a valid license.

Definition at line 12 of file LicenseFeature.h.

Constructor & Destructor Documentation

CPPCli::LicenseFeature::LicenseFeature ( VxSdk::IVxLicenseFeature * vxLicenseFeature )

Constructor.

Parameters

vxLicenseFeature The vx license feature.

Definition at line 8 of file LicenseFeature.cpp.

                                                                              {
     _licenseFeature = vxLicenseFeature;
 }

virtual CPPCli::LicenseFeature::~LicenseFeature ( )

inlinevirtual

Destructor.

Definition at line 24 of file LicenseFeature.h.

                                   {
             this->!LicenseFeature();
         }

CPPCli::LicenseFeature::!LicenseFeature ( )

Finaliser.

Definition at line 12 of file LicenseFeature.cpp.

                                       {
     _licenseFeature->Delete();
     _licenseFeature = nullptr;
 }

Member Function Documentation

List< CPPCli::Device^ > CPPCli::LicenseFeature::_GetCommissionedDevices ( )

package

Definition at line 21 of file LicenseFeature.cpp.

                                                                    {
     // Create a list of managed device objects
     List<CPPCli::Device^>^ mlist = gcnew List<CPPCli::Device^>();
     // Create a collection of unmanaged device objects
     VxSdk::VxCollection<VxSdk::IVxDevice**> devices;
 
     // Make the GetCommissionedDevices call, which will return with the total count of devices, this allows the client to allocate memory.
     VxSdk::VxResult::Value result = _licenseFeature->GetCommissionedDevices(devices);
     // Unless there are no devices on the system, this should return VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // An array of pointers is allocated using the size returned by the previous GetCommissionedDevices call
         devices.collection = new VxSdk::IVxDevice*[devices.collectionSize];
         result = _licenseFeature->GetCommissionedDevices(devices);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < devices.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Device(devices.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] devices.collection;
     }
     return mlist;
 }

CPPCli::Results::Value CPPCli::LicenseFeature::Refresh ( )

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 17 of file LicenseFeature.cpp.

                                                  {
     return (CPPCli::Results::Value)_licenseFeature->Refresh();
 }

Member Data Documentation

VxSdk::IVxLicenseFeature* CPPCli::LicenseFeature::_licenseFeature

package

Definition at line 131 of file LicenseFeature.h.

Property Documentation

System:: String^ CPPCli::LicenseFeature::ActivationId

get

Gets the activation identifier.

The activation identifier.

Definition at line 43 of file LicenseFeature.h.

System:: Collections:: Generic:: List< Device^>^ CPPCli::LicenseFeature::CommissionedDevices

get

Gets the devices that have been commissioned for this feature.

A List of devices that have been commissioned for this feature.

Definition at line 52 of file LicenseFeature.h.

int CPPCli::LicenseFeature::Count

get

Gets the allowable commisions count.

The allowable commisions count.

Definition at line 61 of file LicenseFeature.h.

System:: DateTime CPPCli::LicenseFeature::Expiration

get

Gets the date and time at which the feature will expire.

The date and time at which the feature will expire.

Definition at line 70 of file LicenseFeature.h.

System:: String^ CPPCli::LicenseFeature::Id

get

Gets the unique identifier of the feature.

The unique identifier of the feature.

Definition at line 79 of file LicenseFeature.h.

System:: DateTime CPPCli::LicenseFeature::Installation

get

Gets the date and time at which the feature was installed on the host.

The date and time at which the feature was installed on the host.

Definition at line 88 of file LicenseFeature.h.

bool CPPCli::LicenseFeature::IsPending

get

Gets a value indicating whether this is a "pending" feature, which does not enable any device functionality, or a normal feature that does.

true if this is a "pending" feature, false if a normal feature.

Definition at line 98 of file LicenseFeature.h.

System:: String^ CPPCli::LicenseFeature::Name

get

Gets the name of the feature.

The name of the feature.

Definition at line 107 of file LicenseFeature.h.

int CPPCli::LicenseFeature::Used

get

Gets the amount of the allowable count that is currently used by commissions.

The amount of the allowable count that is currently used by commissions.

Definition at line 116 of file LicenseFeature.h.

System:: String^ CPPCli::LicenseFeature::Version

get

Gets the feature version.

The feature version.

Definition at line 125 of file LicenseFeature.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/LicenseFeature.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/LicenseFeature.cpp

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation