CustomOperatorProxy.LibraryName Property
Gets the name of the library containing the custom operator.
Syntax
public System.String LibraryName { get; }Property Value
Default: ""
The name of the library containing the custom operator.
Remarks
For a .NET custom operator, this is the name of the assembly containing the class implementing the custom operator. The LibraryName can also include an absolute or relative path. Carmenta Engine will first try to load the assembly relative to the directory that contains the configuration file with the CustomOperatorProxy instance and if that fails it will try to load the assembly from the Carmenta Engine bin directory.
For a C++ custom operator, this is the name of the DLL or shared library containing the class implementing the custom operator. The path may be relative to the configuration file. It may also be an absolute path or just the file name without directory; in these cases the standard library loading rules apply.
For a Java custom operator, this property may be set to a list of paths to jar files containing the class definition for the operator, and any other needed Java classes. If several paths are specified, they should be separated by the standard Java path separator for the platform (usually ';' on Windows, ':' on Linux). The paths may be absolute or relative to the configuration file. If specified, these jar files will be added to the Java class path before trying to load the class. In addition, the CECore.Java.jar and CECustomObjects.Java.jar will always be added to the class path. If the class is already included in the class path, this property may be left empty. On Android, this property is not used; the custom operator class must be included in the application package.
When loading a custom operator written in Java, Carmenta Engine will use any Java VM (Virtual Machine) that has already been created by the process. So if the main program is itself a Java application that Java VM will be used by the custom object.
However, if no Java VM is loaded, Carmenta Engine will load the required Java runtime libraries and create a new virtual machine. For this to work, a Java directory must be added to the PATH (Windows) or LD_LIBRARY_PATH (Linux) before starting the process, or the Java runtime will not be found.
On Windows, the directory that needs to be added are the one containing the jvm.dll library, typically C:\Program Files\Java\jre\bin\server.
On Linux, the directory that needs to be added are the one containing the libjvm.so library, typically /usr/lib/jvm/jre/lib/amd64/server.
Platforms
Windows, Linux, Android