CustomOperatorProxy Class
A proxy for a custom operator in map configurations.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public class CustomOperatorProxy : FunnelOperatorRemarks
A custom operator is a .NET, C++ or Java object that implements the ICustomOperator interface. If you have written a custom operator and want to use that operator in a map configuration, you need use a CustomOperatorProxy. The proxy works as regular Carmenta Engine operator, but delegates most calls to the custom object.
There are two different ways to connect the custom operator to the proxy:
If the Api, LibraryName and ClassName properties are set, the proxy will automatically load the specified library and create an instance of the custom operator.
The application can itself create the custom operator instance in application code, and pass it to the proxy by setting the CustomOperator property.
Carmenta Engine will always try to clone the custom operator implementation when it is created by, or attached programatically to, a CustomOperatorProxy. Any error or exception that occur will be re-thrown by Carmenta Engine if/when the clone is needed (the clone is used if the custom operator is part of an operator chain under a selectable TileLayer.).
Custom operators normally prevent tiles, for example in a TileLayer, from being loaded in parallel because there is no requirement that a custom operator implementation is thread-safe. See IsThreadSafe for more information.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Operator
FunnelOperator
CustomOperatorProxy
Platforms
Windows, Linux, Android
CustomOperatorProxy Members
The CustomOperatorProxy type has the following members.
Constructors
| Name | Description |
|---|---|
| CustomOperatorProxy | Initializes a new instance of the CustomOperatorProxy class. |
Properties
| Name | Description |
|---|---|
| Api | Gets the API the custom operator is implemented with. |
| ClassName | Gets the name of the class implementing the custom operator. |
| CustomOperator | Gets or sets the custom operator instance. |
| Description | Gets or sets a short description of the operator. Inherited from Operator |
| DisplayName | Gets or sets a display name for the operator. Inherited from Operator |
| Inputs | Gets the list of inputs connected to this CustomOperatorProxy. Inherited from FunnelOperator |
| IsDisposed | Gets a value that tells whether the current CustomOperatorProxy has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the operator. Inherited from Operator |
| IsThreadSafe | Gets or sets a value that indicates whether the custom operator implementation is thread-safe. |
| LibraryName | Gets the name of the library containing the custom operator. |
| Name | Gets or sets the name of the operator. Inherited from Operator |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CustomOperatorProxy represents. Inherited from EngineObject |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Operator |
| FlushCache | Marks the layer as flushed which will release cached resources during the next update. Inherited from Operator |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Operator |
| GetFeatures | Overloaded. Gets features from the operator chain. Inherited from Operator |
| GetLocalizedDescription | Gets a localized version of the operator description in a specific language. Inherited from Operator |
| GetLocalizedDisplayName | Gets a localized version of the operator display name in a specific language. Inherited from Operator |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Operator |
| GetRasterFeature | Overloaded. Gets raster features from the operator chain and merges them into a single raster. Inherited from Operator |
| HasLocalizedDescription | Checks if a localized version of the operator description is available in a specific language. Inherited from Operator |
| HasLocalizedDisplayName | Checks if a localized version of the operator display name is available in a specific language. Inherited from Operator |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Operator |
| SetLocalizedDescription | Sets a operator description in a specific language. Inherited from Operator |
| SetLocalizedDisplayName | Sets a operator display name in a specific language. Inherited from Operator |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the operator, for a specific language. Inherited from Operator |