SqueezeBrains SDK 1.13
sb_cs::SbLicense Class Reference

License Class that wraps the sb_t_license structure.
You must call the Dispose() method to free all the resources of the returned instance. More...

#include <cs_license.h>

Inheritance diagram for sb_cs::SbLicense:
Collaboration diagram for sb_cs::SbLicense:

Public Member Functions

String FormatInfo ()
 Formats the license structure. More...
 
- Public Member Functions inherited from sb_cs::SbCommon
SbError Error ()
 Returns the error code of the last operation. If no error SbError.SB_ERR_NONE is returned. More...
 
String ErrorMsg ()
 Returns the error message of the last operation. More...
 

Static Public Member Functions

static SbLicense GetInfo ()
 Returns information about the license status. More...
 
static String FormatModuleId (SbLicenseModuleId id)
 Formats the module id More...
 
static String FormatModuleStatus (SbLicenseModuleStatus status)
 Format the module status More...
 
static String FormatType (SbLicenseType type)
 Formats the license type More...
 
static String FormatConfiguration (SbLicenseConfigurationId id)
 Formats the license configuration id More...
 
static String GetHardwareInfo ()
 Returns the hardware information. More...
 
- Static Public Member Functions inherited from sb_cs::SbCommon
static String FormatError (SbError error)
 Returns the error message. More...
 

Data Fields

String address
 Company address.
 
String company
 Company name.
 
String company_role
 Role of the user in the company.
 
String mail
 User mail address.
 
String name
 User name.
 
String operating_system
 Operating system.
 
String phone
 Company phone number.
 
String surname
 Surname.
 
String sector_of_interest
 Sectors of interest of the company.
 
String vat
 Company VAT number.
 
String vendor_code
 vendor code.
 
String machine_id
 machine identifier, uniquely identifies the hardware.
 
array< SbLicenseModule^> module
 Array of the license of the modules Retina, Surface, Deep Surface and Deep Cortex. More...
 
SbTime time_create
 Creation date. More...
 
SbTime time_modify
 Last modification date. More...
 
SbTime time_save
 Last save date. More...
 

Static Public Attributes

static const int LICENSE_MODULE_NUMBER = SB_LICENSE_MODULE_NUMBER
 Number of license modules
 

Detailed Description

License Class that wraps the sb_t_license structure.
You must call the Dispose() method to free all the resources of the returned instance.

Definition at line 177 of file cs_license.h.

Member Function Documentation

◆ FormatConfiguration()

static String sb_cs::SbLicense::FormatConfiguration ( SbLicenseConfigurationId  id)
static

Formats the license configuration id

Parameters
id
Returns
An instance to the String class or null in case of memory error.
See also
sb_license_format_configuration

◆ FormatInfo()

String sb_cs::SbLicense::FormatInfo ( )

Formats the license structure.

Returns
An instance to the String class or null in case of memory error.
See also
sb_license_format_info

◆ FormatModuleId()

static String sb_cs::SbLicense::FormatModuleId ( SbLicenseModuleId  id)
static

Formats the module id

Parameters
idModule id
Returns
An instance to the String class or null in case of memory error.
See also
sb_license_format_module_id

◆ FormatModuleStatus()

static String sb_cs::SbLicense::FormatModuleStatus ( SbLicenseModuleStatus  status)
static

Format the module status

Parameters
statusModule status
Returns
An instance to the String class or null in case of memory error.
See also
sb_license_format_module_status

◆ FormatType()

static String sb_cs::SbLicense::FormatType ( SbLicenseType  type)
static

Formats the license type

Parameters
typeLicense type
Returns
An instance to the String class or null in case of memory error.
See also
sb_license_format_type

◆ GetHardwareInfo()

static String sb_cs::SbLicense::GetHardwareInfo ( )
static

Returns the hardware information.

Returns
An instance to the String class or null in case of memory error.
See also
sb_license_get_hw_info

◆ GetInfo()

static SbLicense sb_cs::SbLicense::GetInfo ( )
static

Returns information about the license status.

Returns
An instance to the SbLicense class or null in case of memory error.
The instance returned is valid only if the SbLicense.Error() is equal to SbError::SB_ERR_NONE, otherwise an error occurred.
You must call the Dispose() method to free all the resources of the returned instance.
See also
sb_license_get_info

Field Documentation

◆ module

array<SbLicenseModule^> sb_cs::SbLicense::module

Array of the license of the modules Retina, Surface, Deep Surface and Deep Cortex.

See also
sb_t_license::module

Definition at line 199 of file cs_license.h.

◆ time_create

SbTime sb_cs::SbLicense::time_create

Creation date.

See also
sb_t_license::time_create

Definition at line 204 of file cs_license.h.

◆ time_modify

SbTime sb_cs::SbLicense::time_modify

Last modification date.

See also
sb_t_license::time_modify

Definition at line 209 of file cs_license.h.

◆ time_save

SbTime sb_cs::SbLicense::time_save

Last save date.

See also
sb_t_license::time_save

Definition at line 214 of file cs_license.h.


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