com.luciad.lucy.addons.tea.loscoverage

LuciadLightspeedClass TLcyLOSCoverageAddOn

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.ALcyPreferencesAddOn

com.luciad.lucy.addons.ALcyFormatAddOn

com.luciad.lucy.addons.tea.loscoverage.TLcyLOSCoverageAddOn

public class TLcyLOSCoverageAddOn
extends ALcyFormatAddOn

Add-on to calculate line-of-sight coverages and visualize these on a GXY map. It provides a terrain analysis back-end, format and GUI.

For line-of-sight support on a Lightspeed map, refer to TLcyLOSAddOn and TLcyLspLOSAddOn .

The back-end performs the actual calculation. It can be used independently of the used GUI.

The GUI's application pane is built by a ALcyApplicationPaneTool, using the add-on's GUI factory. By default, this GUI uses the composite workspace preferences of the add-on's preferences tool.

The add-on's functionality can be changed by extending the back-end, or by extending the GUI builder and tapping into the latter preferences object. See the TEA developer's guide for more information on using and extending TEA add-ons.

Note that this add-on depends on the LuciadLightspeed Terrain Analysis Engine component.

See Also:

TLcyLOSCoverageBackEnd, TLcyLOSCoverageGUIFactory, TLcyPreferencesTool.getCompositeWorkspacePreferences()

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_UPDATE_KEY Determines whether GUI changes should be automatically propagated to the layer and start a new contour calculation.
static boolean	AUTO_UPDATE_VALUE_DEFAULT
static String	COVERAGE_LIST_KEY Property name for the available line-of-sight coverages.
static String	LINKED_LAYER_KEY The ILcdGXYLayer that is linked to the GUI panel.
static ILcdGXYLayer	LINKED_LAYER_VALUE_DEFAULT Default value for the property LINKED_LAYER_KEY.
static String	OUTPUT_FORMAT_KEY Property name for the used output format.
static String	OUTPUT_FORMAT_RASTER_ID Constant identifying a raster-based line-of-sight coverage.
static String	OUTPUT_FORMAT_VALUE_DEFAULT Default value for the property OUTPUT_FORMAT_KEY.
static String	OUTPUT_FORMAT_VECTOR_ID Constant identifying a vector-based line-of-sight coverage.
static String[]	PROPAGATION_LIST_DEFAULT_VALUE Default value for the property PROPAGATION_LIST_KEY.
static String	PROPAGATION_LIST_KEY Property name for the list of propagation functions to choose from.
static String	QUALITY_DESCRIPTIONS_KEY Property name for descriptions of the predefined quality levels to choose from.
static String[]	QUALITY_DESCRIPTIONS_VALUE_DEFAULT Default value for the QUALITY_DESCRIPTIONS_KEY property.
static String	QUALITY_ITEMS_KEY Property name for predefined quality levels to choose from.
static double[]	QUALITY_ITEMS_VALUE_DEFAULT Default value for the QUALITY_ITEMS_KEY property.
static String	QUALITY_KEY Quality property for calculations, expressed in meters per discretization step.
static double	QUALITY_VALUE_DEFAULT Default value for the QUALITY_KEY property.
static String	SELECTED_COVERAGE_KEY Property name for the currently selected coverage.
static String	SELECTED_PROPAGATION_DEFAULT_VALUE Default value for the property SELECTED_PROPAGATION_KEY.
static String	SELECTED_PROPAGATION_KEY Property name for the propagation function to use to calculate a line-of-sight coverage.
static String	SPEEDUP_ENABLED_KEY Property used to turn on/off using OpenCL for ILcdLOSCoverageMatrix calculations.
static boolean	SPEEDUP_ENABLED_VALUE_DEFAULT Default value for the OpenCL line-of-sight speedup enabled property.

Constructor Summary

Constructors

Constructor and Description
TLcyLOSCoverageAddOn() Default constructor for the line-of-sight coverage add-on.

Method Summary

Modifier and Type	Method and Description
protected ALcyApplicationPaneTool	createApplicationPaneTool() Returns the add-on's application pane tool.
protected ALcyFormat	createBaseFormat() Returns a new data format for this add-on.
ALcyFormat	createFormatWrapper(ALcyFormat aBaseFormat) Returns a new data format wrapper for this add-on.
protected ALcyGUIFactory<Component>	createGUIFactory() Returns a new GUI factory for this add-on.
protected TLcyLOSCoverageBackEnd	createLOSCoverageBackEnd() Returns a new back-end for line-of-sight coverage calculations.
protected TLcyPreferencesTool	createPreferencesTool() Creates the TLcyPreferencesTool to be used by this add-on.
ALcyApplicationPaneTool	getApplicationPaneTool() Returns the tool that creates the add-on's application pane.
ALcyGUIFactory<T>	getGUIFactory() Returns the GUI factory to create the add-on's application pane.
TLcyLOSCoverageBackEnd	getLOSCoverageBackEnd() The back-end that the GUI can use for performing line-of-sight coverage calculations.
void	plugInto(ILcyLucyEnv aLucyEnv) Builds a GUI, back-end and file format for line-of-sight coverage calculations and plugs in the GUI and file format.
void	unplugFrom(ILcyLucyEnv aLucyEnv) Unplugs the add-on's format, preferences tool and application pane tool.

Methods inherited from class com.luciad.lucy.addons.ALcyFormatAddOn

createFormatTool, getFormat

Methods inherited from class com.luciad.lucy.addons.ALcyPreferencesAddOn

getLongPrefix, getLucyEnv, getPreferences, getPreferencesTool, getShortPrefix

Methods inherited from class com.luciad.lucy.addons.ALcyAddOn

getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName

Methods inherited from class java.lang.Object

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

Field Detail

COVERAGE_LIST_KEY

public static final String COVERAGE_LIST_KEY

Property name for the available line-of-sight coverages. The associated property value is an array of String objects.

See Also:

SELECTED_COVERAGE_KEY

SELECTED_COVERAGE_KEY

public static final String SELECTED_COVERAGE_KEY

Property name for the currently selected coverage. The associated value is of type String, and denotes the ID that can be used to retrieve the selected coverage's sub-properties. The sub-property suffixes are defined in TLcyLOSCoverageBackEnd.

For example, the domain object for the coverage "Coverage23" can be found in the property named ""TLcyLOSCoverageAddOn.layer.tea.coverage."" + "Coverage23" + "." + TLcyLOSCoverageBackEnd.DOMAIN_OBJECT_CONTEXT_KEY

PROPAGATION_LIST_KEY

public static final String PROPAGATION_LIST_KEY

Property name for the list of propagation functions to choose from. The associated property value is an array of String objects.

See Also:

SELECTED_PROPAGATION_KEY

PROPAGATION_LIST_DEFAULT_VALUE

public static final String[] PROPAGATION_LIST_DEFAULT_VALUE

Default value for the property PROPAGATION_LIST_KEY.

SELECTED_PROPAGATION_KEY

public static final String SELECTED_PROPAGATION_KEY

Property name for the propagation function to use to calculate a line-of-sight coverage. The associated property value is a String. See TLcyLOSCoverageBackEnd for the supported propagation functions. TLcyLOSCoverageBackEnd.createPropagationFunction(com.luciad.lucy.util.properties.ALcyProperties) is used to construct the actual provider.

The property value is used to define propagation function sub-property names. The appropriate sub-property suffixes are defined in TLcyLOSCoverageBackEnd. For example, the altitude mode for the function TLcyLOSCoverageBackEnd.PROPAGATION_FUNCTION_VALUE_NORMAL can be found in the sub-property named:

""TLcyLOSCoverageAddOn.layer.tea.propagation."" +
TLcyLOSCoverageBackEnd.PROPAGATION_FUNCTION_VALUE_NORMAL + "." +
TLcyLOSCoverageBackEnd.ALTITUDE_MODE_KEY

See Also:

TLcyLOSCoverageBackEnd.createPropagationFunction(com.luciad.lucy.util.properties.ALcyProperties), TLcyLOSCoverageBackEnd.retrievePropagationFunctionLabel(java.lang.String)

SELECTED_PROPAGATION_DEFAULT_VALUE

public static final String SELECTED_PROPAGATION_DEFAULT_VALUE

Default value for the property SELECTED_PROPAGATION_KEY.

QUALITY_KEY

public static final String QUALITY_KEY

Quality property for calculations, expressed in meters per discretization step. The corresponding property value is of type double.

See Also:

Constant Field Values

QUALITY_VALUE_DEFAULT

public static final double QUALITY_VALUE_DEFAULT

Default value for the QUALITY_KEY property.

See Also:

Constant Field Values

QUALITY_ITEMS_KEY

public static final String QUALITY_ITEMS_KEY

Property name for predefined quality levels to choose from. The values are sorted by increasing accuracy.

See Also:

Constant Field Values

QUALITY_ITEMS_VALUE_DEFAULT

public static final double[] QUALITY_ITEMS_VALUE_DEFAULT

Default value for the QUALITY_ITEMS_KEY property.

QUALITY_DESCRIPTIONS_KEY

public static final String QUALITY_DESCRIPTIONS_KEY

Property name for descriptions of the predefined quality levels to choose from.

See Also:

Constant Field Values

QUALITY_DESCRIPTIONS_VALUE_DEFAULT

public static final String[] QUALITY_DESCRIPTIONS_VALUE_DEFAULT

Default value for the QUALITY_DESCRIPTIONS_KEY property.

OUTPUT_FORMAT_KEY

public static final String OUTPUT_FORMAT_KEY

Property name for the used output format. The associated property is one of OUTPUT_FORMAT_RASTER_ID or OUTPUT_FORMAT_VECTOR_ID.

See Also:

Constant Field Values

OUTPUT_FORMAT_RASTER_ID

public static final String OUTPUT_FORMAT_RASTER_ID

Constant identifying a raster-based line-of-sight coverage.

See Also:

Constant Field Values

OUTPUT_FORMAT_VECTOR_ID

public static final String OUTPUT_FORMAT_VECTOR_ID

Constant identifying a vector-based line-of-sight coverage.

See Also:

Constant Field Values

OUTPUT_FORMAT_VALUE_DEFAULT

public static final String OUTPUT_FORMAT_VALUE_DEFAULT

Default value for the property OUTPUT_FORMAT_KEY.

See Also:

Constant Field Values

LINKED_LAYER_KEY

public static final String LINKED_LAYER_KEY

The ILcdGXYLayer that is linked to the GUI panel. This value is automatically set when selecting a contour layer in the active map's layer panel. The corresponding property value is of type ILcdGXYLayer

See Also:

Constant Field Values

LINKED_LAYER_VALUE_DEFAULT

public static final ILcdGXYLayer LINKED_LAYER_VALUE_DEFAULT

Default value for the property LINKED_LAYER_KEY.

AUTO_UPDATE_KEY

public static final String AUTO_UPDATE_KEY

Determines whether GUI changes should be automatically propagated to the layer and start a new contour calculation. The corresponding property value is a boolean.

See Also:

Constant Field Values

AUTO_UPDATE_VALUE_DEFAULT

public static final boolean AUTO_UPDATE_VALUE_DEFAULT

See Also:

Constant Field Values

SPEEDUP_ENABLED_KEY

public static final String SPEEDUP_ENABLED_KEY

Property used to turn on/off using OpenCL for ILcdLOSCoverageMatrix calculations. The corresponding property value is of type boolean.

See Also:

Constant Field Values

SPEEDUP_ENABLED_VALUE_DEFAULT

public static final boolean SPEEDUP_ENABLED_VALUE_DEFAULT

Default value for the OpenCL line-of-sight speedup enabled property. This value will be used when no valid value is specified in the configuration file of the TLcyLOSCoverageAddOn.

See Also:

Constant Field Values

Constructor Detail

TLcyLOSCoverageAddOn

public TLcyLOSCoverageAddOn()

Default constructor for the line-of-sight coverage add-on.

Method Detail

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Builds a GUI, back-end and file format for line-of-sight coverage calculations and plugs in the GUI and file format.

Parameters:

aLucyEnv - the Lucy instance to plug into

See Also:

ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)

getLOSCoverageBackEnd

public TLcyLOSCoverageBackEnd getLOSCoverageBackEnd()

The back-end that the GUI can use for performing line-of-sight coverage calculations.

Override createLOSCoverageBackEnd() to extend the back-end.

Returns:

a TLcyLOSCoverageBackEnd object for performing line-of-sight coverage calculations

See Also:

createLOSCoverageBackEnd(), TLcyLOSCoverageBackEnd

createLOSCoverageBackEnd

protected TLcyLOSCoverageBackEnd createLOSCoverageBackEnd()

Returns a new back-end for line-of-sight coverage calculations. Override this method to extend the default back-end with new functionality.

Returns:

a new back-end for extreme point calculations

createBaseFormat

protected ALcyFormat createBaseFormat()

Returns a new data format for this add-on. Override this method to extend the default format with new functionality.

For example, to alter the icon of the layers of this format, you can decorate the layer factory created in the format:

 @Override
 protected ALcyFormat createBaseFormat() {
   return new ALcyFormatWrapper(super.createBaseFormat()){
     @Override
     protected ILcdGXYLayerFactory createGXYLayerFactory(){
       final ILcdGXYLayerFactory delegate = super.createGXYLayerFactory();
       return new ILcdGXYLayerFactory(){
         @Override
         public ILcdGXYLayer createGXYLayer(ILcdModel aModel){
           ILcdGXYLayer layer = delegate.createGXYLayer(aModel);
           if (layer != null){
             ILcdIcon icon = ...;
             layer.setIcon(icon);
           }
           return layer;
         }
       }
     }
   }
 }
 

Note that the created format is at least wrapped by a TLcySafeGuardFormatWrapper (or equivalent) before it is plugged in ILcyLucyEnv (using e.g. TLcyFormatTool). So it is safe to rely on the safety checks performed by that wrapper.

Returns:

a new file format for this add-on

createFormatWrapper

public final ALcyFormat createFormatWrapper(ALcyFormat aBaseFormat)

Description copied from class: ALcyFormatAddOn

Returns a new data format wrapper for this add-on. A format wrapper extends the base format with aspects such as asynchronous painting, mutable file behavior, safe guarding, etc.

Overriding this method of an existing add-on should be done with extreme care as add-ons typically rely on the wrappers that should be present (e.g. a safe guard).

Specified by:

createFormatWrapper in class ALcyFormatAddOn

Parameters:

aBaseFormat - the base format to wrap

Returns:

a new format for this add-on

See Also:

ALcyFormatWrapper

createGUIFactory

protected ALcyGUIFactory<Component> createGUIFactory()

Returns a new GUI factory for this add-on. Override this method to extend the default GUI with new functionality.

For example, this add-on could return a new instance of TLcyLOSCoverageGUIFactory

Returns:

a new GUI factory for this add-on

createApplicationPaneTool

protected ALcyApplicationPaneTool createApplicationPaneTool()

Returns the add-on's application pane tool. Override this method to add to the default application pane tool's functionality.

This add-on's application pane tool initializes the GUI factory with the add-on's composite workspace preferences. It also ensures that the panel is updated from the selected TEA layer's stored GUI properties.

Returns:

the add-on's application pane tool

See Also:

TLcyLOSCoverageGUIFactory.UPDATE_LAYER_ACTION

getGUIFactory

public ALcyGUIFactory<T> getGUIFactory()

Returns the GUI factory to create the add-on's application pane. See createGUIFactory() if you want to override or extend the add-on's factory.

Returns:

the add-on's GUI factory

getApplicationPaneTool

public ALcyApplicationPaneTool getApplicationPaneTool()

Returns the tool that creates the add-on's application pane. See createApplicationPaneTool() if you want to override or extend the add-on's application pane tool.

Returns:

the tool that creates the add-on's application pane

unplugFrom

public void unplugFrom(ILcyLucyEnv aLucyEnv)

Unplugs the add-on's format, preferences tool and application pane tool.

Overrides:

unplugFrom in class ALcyFormatAddOn

Parameters:

aLucyEnv - the Lucy environment

See Also:

ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)

createPreferencesTool

protected TLcyPreferencesTool createPreferencesTool()

Creates the TLcyPreferencesTool to be used by this add-on. Overwriting this method for example allows to register additional ILcyPropertyConverters for (complex) custom properties, to make sure they are correctly decoded from the add-on's configuration file and/or saved to the workspace. Note that this isn't required for simple properties such as String, int, double, etc.

Overrides:

createPreferencesTool in class ALcyPreferencesAddOn

Returns:

the created TLcyPreferencesTool.