CustomOperatorAdapter Class
Adapter class that can be used as a base-class to simplify the implementation of a custom operator.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public abstract class CustomOperatorAdapter : ICustomOperatorRemarks
The CustomOperatorAdapter class is an adapter class that is intended to be used as a base-class to simplify an implementation of the ICustomOperator interface.
To implement a custom operator using this class do the following:
Inherit a class from CustomOperatorAdapter.
Select which processing mode the custom operator should use by passing one of the ProcessingMode values to the base class constructor.
Override the OnProcess method to process one or all, depending on the selected processing mode, features.
Override the OnClone method to return a copy of the custom operator.
Add the IMinimizeGarbageCollection interface to .NET or Java implementations that do not cache objects between updates.
The Custom Operator Sample demonstrates how this class can be used to implement a custom operator.
Exceptions that are thrown by custom object implementations will be logged and then propagated by Carmenta Engine as an EngineException to the application. Also, the only way a C++ custom object implementation can include a relevant error message to an application is by throwing an EngineException.
This adapter class is suitable for many custom operator implementations but if you need more control you can always implement the ICustomOperator interface directly instead.
Also, the CustomOperatorAdapter implements the ICustomOperator interface itself so classes that inherit from CustomOperatorAdapter should not override any ICustomOperator members even though they might be visible in the subclass.
Optimizing the performance of .NET and Java custom objects
Custom objects that are implemented in .NET or Java, both of which use a garbage collector to manage memory, can generate a lot of temporary object instances that must be collected and finalized by the garbage collector. These temporary objects can, depending on how many times a custom object is called during a typical update cycle, generate so much extra work for the garbage collector that it has a significant impact on performance.
In many cases you can improve the performance by adding the IMinimizeGarbageCollection interface to the custom operator implementation. This tells Carmenta Engine that reference objects passed to, and returned from, the custom object should be disposed automatically which decreases the work that must be performed by the garbage collector.
Inheritance Hierarchy
System.Object (not available in C#)
CustomOperatorAdapter
Platforms
Windows, Linux, Android
CustomOperatorAdapter Members
The CustomOperatorAdapter type has the following members.
Constructors
| Name | Description |
|---|---|
| CustomOperatorAdapter | Initializes a new instance of the CustomOperatorAdapter class with the specified ProcessingMode. |
Properties
| Name | Description |
|---|---|
| All | Gets all Feature instances that are being processed by the custom operator. |
| Context | Gets the CustomOperatorContext that was used to initialize this CustomOperatorAdapter. |
| Current | Gets the current Feature that is being processed by the custom operator. |
Methods
| Name | Description |
|---|---|
| OnClone | Called to clone the CustomOperatorAdapter. This method must be implemented. |
| OnInitialize | Called when the custom operator is initialized. |
| OnPrepare | Called to prepare the custom operator for an update cycle. |
| OnProcess | Called to process and features that pass through the custom operator. This method must be implemented. |