com.openinventor.inventor.algorithms

Class SoAlgorithms

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.algorithms.SoAlgorithms

public class SoAlgorithms
extends Inventor

Utility functions for loading algorithm modules. This class provides convenience methods for loading an algorithm module, extracting specific algorithm interfaces and creating appropriate context and buffer objects for the device that implements the algorithms.

Examples:

Nested Class Summary

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 and Description
SoAlgorithms() Algorithms interface constructor.

Method Summary

Modifier and Type	Method and Description
SoArithmetic	createArithmeticInterface() Returns an instance of the SoArithmetic interface defined in the loaded module.
SoBufferObject	createBufferObject() Returns an instance of a SoBufferObject according to the hardware used by the loaded module (eg.
SoDeviceContext	createContext() Returns a DeviceContext that can be used with the algorithms module and SoBufferObject returned by the createBufferObject function.
SoConversion	createConversionInterface() Returns an instance of the SoConversion interface defined in the loaded module.
SoConvolution	createConvolutionInterface() Returns an instance of the SoConvolution interface defined in the loaded module.
SoDataExtract	createDataExtractInterface() Returns an instance of the SoDataExtract interface defined in the loaded module.
SoSeismic	createSeismicInterface() Returns an instance of the SoSeismic interface defined in the loaded module.
static void	finish() Static finish function to free the memory allocated by the algorithms module.
static void	init() Static init function to initialize the algorithms module.
static boolean	isInitialized() Returns true if module is currently initialized.
static SoAlgorithms	loadAlgorithmsModule(java.lang.String moduleFileName) Loads a module and returns an instance of the implementation of SoAlgorithms in this module.
static boolean	unloadAlgorithmsModule(java.lang.String moduleFileName) Unloads a module.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Constructor Detail

SoAlgorithms

public SoAlgorithms()

Algorithms interface constructor.

Method Detail

createArithmeticInterface

public SoArithmetic createArithmeticInterface()

Returns an instance of the SoArithmetic interface defined in the loaded module. If there is no loaded module it returns the default CPU version.

Returns:

Instance of the SoArithmetic interface.

loadAlgorithmsModule

public static SoAlgorithms loadAlgorithmsModule(java.lang.String moduleFileName)

Loads a module and returns an instance of the implementation of SoAlgorithms in this module. If the module is already loaded this function just increments the reference count and returns a new instance of the algorithms interface.

Parameters:

moduleFileName - The module filename. See the description of this class for more information.

Returns:

An instance of the Algorithms interface from the module, or NULL if the module cannot be load.

createConvolutionInterface

public SoConvolution createConvolutionInterface()

Returns an instance of the SoConvolution interface defined in the loaded module. If there is no loaded module it returns the default CPU version.

Returns:

Instance of the SoConvolution interface.

isInitialized

public static boolean isInitialized()

Returns true if module is currently initialized.

init

public static void init()

Static init function to initialize the algorithms module.

finish

public static void finish()

Static finish function to free the memory allocated by the algorithms module.

createDataExtractInterface

public SoDataExtract createDataExtractInterface()

Returns an instance of the SoDataExtract interface defined in the loaded module. If there is no loaded module it returns the default CPU version.

Returns:

Instance of the SoDataExtract interface.

createBufferObject

public SoBufferObject createBufferObject()

Returns an instance of a SoBufferObject according to the hardware used by the loaded module (eg. It returns an SoCudaBufferObject if a CUDA module was loaded.).

If there is no loaded module this function returns an SoCpuBufferObject.

Returns:

An Instance of a SoBufferObject.

createContext

public SoDeviceContext createContext()

Returns a DeviceContext that can be used with the algorithms module and SoBufferObject returned by the createBufferObject function.

Returns:

An instance of an SoDeviceContext object.

createSeismicInterface

public SoSeismic createSeismicInterface()

Returns an instance of the SoSeismic interface defined in the loaded module. If there is no loaded module it returns the default CPU version.

Returns:

Instance of the SoSeismic interface.

unloadAlgorithmsModule

public static boolean unloadAlgorithmsModule(java.lang.String moduleFileName)

Unloads a module. The module is unloaded only if it is not used anymore, it uses a references counter in order to figure out if the module can be unloaded or not.

Parameters:

moduleFileName - The module filename to unload.

createConversionInterface

public SoConversion createConversionInterface()

Returns an instance of the SoConversion interface defined in the loaded module. If there is no loaded module it returns the default CPU version.

Returns:

Instance of the SoConversion interface.