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. The getProduct() method returns the SbProduct enum value corresponding to the product. The getLicenseCount() method gives you the number of licenses available. The getLicenseByIndex() method gives you a SoLicenseProperty containing license info for this product.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	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

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.
String	getProductName()	Returns the name of the licensed product.
boolean	isDisposable()	Returns a boolean flag which indicates if it is safe to call SafeDisposable.dispose() on the object.

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoLicensedProduct

public SoLicensedProduct()

Method Details

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 interface SafeDisposable

Overrides:

dispose in class Inventor

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 call SafeDisposable.dispose() on the object.

Specified by:

isDisposable in interface SafeDisposable

Returns:

true if the object can be disposed in a safe manner

getProductName

public 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 by getLicenseCount(), the method returns NULL.