VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxLicense Struct Referenceabstract

Represents license information for the resource that owns this resource. More...

#include <IVxLicense.h>

Public Member Functions

virtual VxResult::Value CommissionDevice (IVxDevice &device) const =0
 Commissions a device for use within the VideoXpert system. More...
 
virtual VxResult::Value DecommissionDevice (IVxDevice &device) const =0
 Decommissions a device on the VideoXpert system. More...
 
virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetLicenseFeatures (VxCollection< IVxLicenseFeature ** > &licenseFeatureCollection) const =0
 Gets the features this license contains. More...
 

Public Attributes

char companyName [64]
 The friendly name of the owning company/organization. More...
 
VxSystemLicenseType::Value systemLicenseType
 The type of system that this license is applied to. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents license information for the resource that owns this resource.

Definition at line 13 of file IVxLicense.h.

Member Function Documentation

void VxSdk::IVxLicense::Clear ( )
inlineprotected

Clears this instance.

Definition at line 53 of file IVxLicense.h.

53  {
54  VxZeroArray(this->companyName);
55  systemLicenseType = VxSystemLicenseType::kUnknown;
56  }
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxLicense::systemLicenseType
VxSystemLicenseType::Value systemLicenseType
The type of system that this license is applied to.
Definition: IVxLicense.h:47
VxSdk::VxSystemLicenseType::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:927
VxSdk::IVxLicense::companyName
char companyName[64]
The friendly name of the owning company/organization.
Definition: IVxLicense.h:43
virtual VxResult::Value VxSdk::IVxLicense::CommissionDevice ( IVxDevice &  device) const
pure virtual

Commissions a device for use within the VideoXpert system.

Parameters
deviceThe device to commission.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxLicense::DecommissionDevice ( IVxDevice &  device) const
pure virtual

Decommissions a device on the VideoXpert system.

Parameters
deviceThe device to decommission.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxLicense::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxLicense::GetLicenseFeatures ( VxCollection< IVxLicenseFeature ** > &  licenseFeatureCollection) const
pure virtual

Gets the features this license contains.

Parameters
licenseFeatureCollectionA VxCollection of the features this license contains.
Returns
The Result of the request.

Member Data Documentation

char VxSdk::IVxLicense::companyName[64]

The friendly name of the owning company/organization.

Definition at line 43 of file IVxLicense.h.

VxSystemLicenseType::Value VxSdk::IVxLicense::systemLicenseType

The type of system that this license is applied to.

Definition at line 47 of file IVxLicense.h.

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