com.luciad.tea

Terrain Analysis EngineClass TLcdHeightProviderAdapter

java.lang.Object

com.luciad.tea.ALcdTerrainElevationProvider

com.luciad.tea.TLcdHeightProviderAdapter

All Implemented Interfaces:

ILcdAltitudeProvider

public class TLcdHeightProviderAdapter
extends ALcdTerrainElevationProvider

This class wraps an ILcdHeightProvider to implement the ILcdAltitudeProvide interface.

Since:

9.1

Constructor Summary

Constructors

Constructor and Description
TLcdHeightProviderAdapter(ILcdHeightProvider aHeightProvider, ILcdGeoReference aReference) Create en new TLcdHeightProviderAdapter using the given ILcdHeightProvider.

Method Summary

Modifier and Type	Method and Description
ILcdGeoReference	getPreferredReference() Returns the preferred reference for this terrain elevation provider.
double	retrieveElevationAt(ILcdPoint aPoint, ILcdGeoReference aPointReference) Returns the elevation for a given location, defined in meters above the geoid from the given location reference.

Methods inherited from class com.luciad.tea.ALcdTerrainElevationProvider

getAltitudeDescriptor, getAltitudeMode, isValidElevation, retrieveAltitudeAt

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdHeightProviderAdapter

public TLcdHeightProviderAdapter(ILcdHeightProvider aHeightProvider,
                                 ILcdGeoReference aReference)

Create en new TLcdHeightProviderAdapter using the given ILcdHeightProvider.

Parameters:

aHeightProvider - the ILcdHeightProvider to be wrapped.

aReference - the reference in which the ILcdHeightProvider is defined.

Method Detail

retrieveElevationAt

public double retrieveElevationAt(ILcdPoint aPoint,
                                  ILcdGeoReference aPointReference)

Description copied from class: ALcdTerrainElevationProvider

Returns the elevation for a given location, defined in meters above the geoid from the given location reference.

Special elevation values should be interpreted as defined by the altitude descriptor (from ALcdTerrainElevationProvider.getAltitudeDescriptor()). Keep in mind that Double.NaN, Double.NEGATIVE_INFINITY and Double.POSITIVE_INFINITY can also be used as special values.

Specified by:

retrieveElevationAt in class ALcdTerrainElevationProvider

Parameters:

aPoint - The point indicating the location for which to retrieve the elevation.

aPointReference - The reference in which the given location is defined. Note that the ellipsoid from this reference should be used to define the returning elevation value.

Returns:

the elevation for a given location, defined in meters above the ellipsoid.

getPreferredReference

public ILcdGeoReference getPreferredReference()

Description copied from class: ALcdTerrainElevationProvider

Returns the preferred reference for this terrain elevation provider. This reference is the reference with the best performance when used as a parameter in the method ALcdTerrainElevationProvider.retrieveElevationAt(ILcdPoint, ILcdGeoReference). It is perfectly correct to use points with other references. It will be faster to use the preferred.

For performance reasons, the preferred reference should be the reference of the available elevation data to minimize the number of point transformations. By default, this method returns null.

Keep in mind that this function can return null if no preferred reference is available.

Specified by:

getPreferredReference in interface ILcdAltitudeProvider

Overrides:

getPreferredReference in class ALcdTerrainElevationProvider

Returns:

the preferred reference of this terrain elevation provider. Note that null can be returned if no preferred reference is available.

See Also:

ALcdTerrainElevationProvider.retrieveElevationAt(ILcdPoint,ILcdGeoReference)