Package com.openinventor.inventor.lock
Class SoLicensedProduct
- java.lang.Object
-
- com.openinventor.inventor.Inventor
-
- com.openinventor.inventor.lock.SoLicensedProduct
-
- All Implemented Interfaces:
SafeDisposable
public class SoLicensedProduct extends Inventor implements SafeDisposable
Class managing a licensed product.SoLicensedProduct
manages a licensed product. This class provides information about the current available licenses for a given product. ThegetProduct()
method returns the SbProduct enum value corresponding to the product. ThegetLicenseCount()
method gives you the number of licenses available. ThegetLicenseByIndex()
method gives you aSoLicenseProperty
containing license info for this product.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SoLicensedProduct.SbProducts
List of all available Open Inventor products.-
Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand
-
-
Field Summary
-
Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle
-
-
Constructor Summary
Constructors Constructor Description SoLicensedProduct()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
dispose()
Explicitly call this method to force object to dispose its unmanaged resources.SoLicenseProperty
getLicenseByIndex(int index)
Returns the license of the licensed product for the given index.int
getLicenseCount()
Returns the number of licenses available for this product.SoLicensedProduct.SbProducts
getProduct()
Returns the SbProduct enum value of the licensed product.java.lang.String
getProductName()
Returns the name of the licensed product.boolean
isDisposable()
Returns a boolean flag which indicates if it is safe to callSafeDisposable.dispose()
on the object.-
Methods inherited from class com.openinventor.inventor.Inventor
getNativeResourceHandle
-
-
-
-
Method Detail
-
dispose
public boolean dispose()
Description copied from class:Inventor
Explicitly call this method to force object to dispose its unmanaged resources. The object may not be reused in the application code after this call.- Specified by:
dispose
in interfaceSafeDisposable
- Overrides:
dispose
in classInventor
- Returns:
true
if this object native resources were successfully disposed;false
if it was already disposed or no native resources has been registered for this object.
-
isDisposable
public boolean isDisposable()
Description copied from interface:SafeDisposable
Returns a boolean flag which indicates if it is safe to callSafeDisposable.dispose()
on the object.- Specified by:
isDisposable
in interfaceSafeDisposable
- Returns:
true
if the object can be disposed in a safe manner
-
getProductName
public java.lang.String getProductName()
Returns the name of the licensed product.
-
getProduct
public SoLicensedProduct.SbProducts getProduct()
Returns the SbProduct enum value of the licensed product.
-
getLicenseCount
public int getLicenseCount()
Returns the number of licenses available for this product.
-
getLicenseByIndex
public SoLicenseProperty getLicenseByIndex(int index)
Returns the license of the licensed product for the given index. If the given index is greater than the value returned bygetLicenseCount()
, the method returns NULL.
-
-