ICustomPropagation Interface

Interface for a custom propagation model that can be used by an instance of LineOfSightOperator or one of its derived classes.

public interface ICustomPropagation

Remarks

A custom propagation is an object written by an application developer that extends the standard functionality of the Carmenta Engine operator LineOfSightOperator or its subclasses TargetLineOfSightOperator and AirspaceCoverageOperator. The custom propagation is just a regular class that can be written in C++, Java, or any Microsoft .NET language like C#, that implements the ICustomPropagation interface.

The custom propagation can be used in a map configuration via a CustomPropagationProxy object that is used as the customPropagation property of the operator. The presence of the proxy object will make the operator skip its standard line-of-sight propagation algorithm along each vertical profile radiating from the observer; instead, the operator will delegate the calculation to your custom object by calling its Propagate method. In this way, you can implement a non-standard propagation model for line-of-sight, or other propagation models for radio, sound, ballistic trajectories, etc. However, a basic limitation is that the vertical profiles from the observer always follow straight routes, so you cannot implement a model where diffraction allows radio signals to bend sideways around a building, for example.

In the folder samples/CustomObjects you will find an example with a non-standard line-of-sight propagation model that assumes that forests and shrubs are semitransparent, and the generated raster indicates the probability of sight. See also An Overview of the Carmenta Engine Custom Object Samples.

Custom propagation sample loaded into Carmenta Explorer.

Please see CustomPropagationProxy for more information how to configure and load the custom object.

The ICustomPropagation interface contains six methods: Clone, InitNew, Prepare, Propagate, NeedsEquidistantProfilePoints and OutputType. Your implementation must ensure that they are threadsafe, since the operators that call them will assume that.

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.

Platforms

Windows, Linux, Android

ICustomPropagation Members

The ICustomPropagation type has the following members.

Methods

ICustomPropagation Interface

Interface for a custom propagation model that can be used by an instance of LineOfSightOperator or one of its derived classes.

class ICustomPropagation

typedef Ptr<ICustomPropagation> ICustomPropagationPtr;

Remarks

A custom propagation is an object written by an application developer that extends the standard functionality of the Carmenta Engine operator LineOfSightOperator or its subclasses TargetLineOfSightOperator and AirspaceCoverageOperator. The custom propagation is just a regular class that can be written in C++, Java, or any Microsoft .NET language like C#, that implements the ICustomPropagation interface.

The custom propagation can be used in a map configuration via a CustomPropagationProxy object that is used as the customPropagation property of the operator. The presence of the proxy object will make the operator skip its standard line-of-sight propagation algorithm along each vertical profile radiating from the observer; instead, the operator will delegate the calculation to your custom object by calling its propagate method. In this way, you can implement a non-standard propagation model for line-of-sight, or other propagation models for radio, sound, ballistic trajectories, etc. However, a basic limitation is that the vertical profiles from the observer always follow straight routes, so you cannot implement a model where diffraction allows radio signals to bend sideways around a building, for example.

In the folder samples/CustomObjects you will find an example with a non-standard line-of-sight propagation model that assumes that forests and shrubs are semitransparent, and the generated raster indicates the probability of sight. See also An Overview of the Carmenta Engine Custom Object Samples.

Custom propagation sample loaded into Carmenta Explorer.

Please see CustomPropagationProxy for more information how to configure and load the custom object.

The ICustomPropagation interface contains six methods: clone, initNew, prepare, propagate, needsEquidistantProfilePoints and outputType. Your implementation must ensure that they are threadsafe, since the operators that call them will assume that.

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.

Platforms

Windows, Linux, Android

ICustomPropagation Members

The ICustomPropagation type has the following members.

Methods

ICustomPropagation Interface

Interface for a custom propagation model that can be used by an instance of LineOfSightOperator or one of its derived classes.

public interface ICustomPropagation

Remarks

A custom propagation is an object written by an application developer that extends the standard functionality of the Carmenta Engine operator LineOfSightOperator or its subclasses TargetLineOfSightOperator and AirspaceCoverageOperator. The custom propagation is just a regular class that can be written in C++, Java, or any Microsoft .NET language like C#, that implements the ICustomPropagation interface.

The custom propagation can be used in a map configuration via a CustomPropagationProxy object that is used as the customPropagation property of the operator. The presence of the proxy object will make the operator skip its standard line-of-sight propagation algorithm along each vertical profile radiating from the observer; instead, the operator will delegate the calculation to your custom object by calling its propagate method. In this way, you can implement a non-standard propagation model for line-of-sight, or other propagation models for radio, sound, ballistic trajectories, etc. However, a basic limitation is that the vertical profiles from the observer always follow straight routes, so you cannot implement a model where diffraction allows radio signals to bend sideways around a building, for example.

In the folder samples/CustomObjects you will find an example with a non-standard line-of-sight propagation model that assumes that forests and shrubs are semitransparent, and the generated raster indicates the probability of sight. See also An Overview of the Carmenta Engine Custom Object Samples.

Custom propagation sample loaded into Carmenta Explorer.

Please see CustomPropagationProxy for more information how to configure and load the custom object.

The ICustomPropagation interface contains six methods: clone, initNew, prepare, propagate, needsEquidistantProfilePoints and outputType. Your implementation must ensure that they are threadsafe, since the operators that call them will assume that.

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.

Platforms

Windows, Linux, Android

ICustomPropagation Members

The ICustomPropagation type has the following members.

Methods

ICustomPropagation Interface

This element is not available using the selected API.