ALcyTEABackEnd (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.lucy.addons.tea.ALcyTEABackEnd

Direct Known Subclasses:

TLcyContourBackEnd, TLcyExtremePointBackEnd, TLcyHypsometryBackEnd, TLcyLOSCoverageBackEnd, TLcyTEAControllerBackEnd, TLcyViewshedBackEnd, TLcyVisibilityBackEnd
```
public abstract class ALcyTEABackEnd
extends Object
```
Provides back-end functionality for a TEA add-on. Its methods can be called to programmatically perform the same operations as the GUI does, or to create a custom TEA GUI. Also, a back-end can be extended to overwrite various methods in order to fine-tune its behavior.
To allow easy extension of a back-end, the method parameters are passed via ALcyProperties objects.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALTITUDE_PROVIDER_KEY` Altitude provider property name for the back-end methods properties arguments.
`static String`	`DISPLAY_NAME_KEY` Display name property name for the back-end properties arguments.
`static String`	`MODEL_DISPLAY_NAME_KEY` Model display property name for the back-end properties arguments.
`static String`	`MODEL_REFERENCE_KEY` Model reference property name for the back-end properties arguments.
`static String`	`QUALITY_KEY` Quality property name for the back-end properties arguments, expressed in meters per discretization step.
`static String`	`SHAPE_KEY` Shape property name for the back-end properties arguments.
`static String`	`SHAPE_REFERENCE_KEY` Shape model reference property name for the back-end properties arguments, describing the georeference of the `SHAPE_KEY` property.
`static String`	`SOURCE_NAME_KEY` Source name property name for the back-end properties arguments.
`static String`	`TARGET_REFERENCE_KEY` Target reference property name for the back-end properties arguments.
`static String`	`VIEW_KEY` View property name for the back-end properties arguments.

Constructor Summary

Constructors
Constructor and Description

ALcyTEABackEnd(ILcyLucyEnv aLucyEnv)
Default constructor for a TEA back-end.

Constructors
Constructor and Description
`ALcyTEABackEnd(ILcyLucyEnv aLucyEnv)` Default constructor for a TEA back-end.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TLcdAltitudeDescriptor`	`createAltitudeDescriptor(ALcyProperties aProperties)` Returns an altitude descriptor suitable for the add-on's purposes.
`TLcdAltitudeMatrixViewFactory`	`createAltitudeMatrixViewFactory(ALcyProperties aProperties)` Returns a factory for `ILcdAltitudeMatrixView` shape discretization objects.
`ILcdAltitudeProvider`	`createAltitudeProvider(ALcyProperties aProperties)` Returns a view-based altitude provider.
`abstract ILcdModelDescriptor`	`createModelDescriptor(ALcyProperties aProperties)` Returns a model descriptor suitable for the add-on's used models.
`ILcyLucyEnv`	`getLucyEnv()` Returns the Lucy environment into which the back-end was plugged.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SOURCE_NAME_KEY
```
public static final String SOURCE_NAME_KEY
```
    Source name property name for the back-end properties arguments. The corresponding value is of type String.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME_KEY
```
public static final String DISPLAY_NAME_KEY
```
    Display name property name for the back-end properties arguments. The corresponding value is of type String.
    
    See Also:
    
    Constant Field Values
  - VIEW_KEY
```
public static final String VIEW_KEY
```
    View property name for the back-end properties arguments. The corresponding value is of type ILcdGXYView.
    
    See Also:
    
    Constant Field Values
  - QUALITY_KEY
```
public static final String QUALITY_KEY
```
    Quality property name for the back-end properties arguments, expressed in meters per discretization step. The corresponding property value is of type double.
    
    See Also:
    
    Constant Field Values
  - SHAPE_KEY
```
public static final String SHAPE_KEY
```
    Shape property name for the back-end properties arguments. The corresponding property value is of type ILcdShape.
    
    See Also:
    
    Constant Field Values
  - SHAPE_REFERENCE_KEY
```
public static final String SHAPE_REFERENCE_KEY
```
    Shape model reference property name for the back-end properties arguments, describing the georeference of the SHAPE_KEY property. The corresponding property value is of type ILcdGeoReference.
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_PROVIDER_KEY
```
public static final String ALTITUDE_PROVIDER_KEY
```
    Altitude provider property name for the back-end methods properties arguments. The corresponding property value is of type ILcdAltitudeProvider.
    
    See Also:
    
    Constant Field Values
  - MODEL_DISPLAY_NAME_KEY
```
public static final String MODEL_DISPLAY_NAME_KEY
```
    Model display property name for the back-end properties arguments. The corresponding property value is of type String.
    
    See Also:
    
    Constant Field Values
  - MODEL_REFERENCE_KEY
```
public static final String MODEL_REFERENCE_KEY
```
    Model reference property name for the back-end properties arguments. The corresponding property value is of type ILcdModelReference.
    
    See Also:
    
    Constant Field Values
  - TARGET_REFERENCE_KEY
```
public static final String TARGET_REFERENCE_KEY
```
    Target reference property name for the back-end properties arguments. The corresponding property value is of type ILcdModelReference.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ALcyTEABackEnd
```
public ALcyTEABackEnd(ILcyLucyEnv aLucyEnv)
```
    Default constructor for a TEA back-end.
    
    Parameters:
    
    aLucyEnv - the Lucy environment to plug the back-end into.
- Method Detail
  - getLucyEnv
```
public ILcyLucyEnv getLucyEnv()
```
    Returns the Lucy environment into which the back-end was plugged.
    
    Returns:
    
    the Lucy environment into which the back-end was plugged
  - createModelDescriptor
```
public abstract ILcdModelDescriptor createModelDescriptor(ALcyProperties aProperties)
```
    Returns a model descriptor suitable for the add-on's used models.
    Parameters:
    aProperties - a properties object with the following parameters:
    
    SOURCE_NAME_KEY: The source name that was used to retrieve the data from, use null to indicate that it was created from scratch.
    DISPLAY_NAME_KEY: the display name that the model descriptor should use @return a suitable model descriptor
    Returns:
    
    the created ILcdModelDescriptor.
  - createAltitudeProvider
```
public ILcdAltitudeProvider createAltitudeProvider(ALcyProperties aProperties)
```
    Returns a view-based altitude provider.
    Parameters:
    aProperties - a properties object with the following parameters:
    
    VIEW_KEY the view for which to provide altitude values
    QUALITY_KEY the quality value to base the provider's pixel density on
    Returns:
    
    a view-based altitude provider
  - createAltitudeDescriptor
```
public TLcdAltitudeDescriptor createAltitudeDescriptor(ALcyProperties aProperties)
```
    Returns an altitude descriptor suitable for the add-on's purposes.
    
    Parameters:
    
    aProperties - this implementation does not use any properties
    
    Returns:
    
    an altitude descriptor suitable for the add-on's purposes
  - createAltitudeMatrixViewFactory
```
public TLcdAltitudeMatrixViewFactory createAltitudeMatrixViewFactory(ALcyProperties aProperties)
```
    Returns a factory for ILcdAltitudeMatrixView shape discretization objects.
    
    Parameters:
    
    aProperties - this implementation does not use any properties
    
    Returns:
    
    a factory for ILcdAltitudeMatrixView objects

LuciadLightspeedClass ALcyTEABackEnd

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SOURCE_NAME_KEY

DISPLAY_NAME_KEY

VIEW_KEY

QUALITY_KEY

SHAPE_KEY

SHAPE_REFERENCE_KEY

ALTITUDE_PROVIDER_KEY

MODEL_DISPLAY_NAME_KEY

MODEL_REFERENCE_KEY

TARGET_REFERENCE_KEY

Constructor Detail

ALcyTEABackEnd

Method Detail

getLucyEnv

createModelDescriptor

createAltitudeProvider

createAltitudeDescriptor

createAltitudeMatrixViewFactory