org.esa.beam.framework.dataop.dem
Interface ElevationModelDescriptor

All Known Implementing Classes:

AbstractElevationModelDescriptor

public interface ElevationModelDescriptor

An ElevationModel is used to obtain an elevation above a specified geographical datum for a given geographical position.

Version:

$Revision$

Author:

Norman Fomferra

Field Summary

static int	DEM_INSTALLATION_CANCELED
static int	DEM_INSTALLATION_ERROR
static int	DEM_INSTALLATION_IN_PROGRESS
static int	DEM_INSTALLED

Method Summary

ElevationModel	createDem(Resampling resampling) Creates the elevation model instance.
Datum	getDatum() Gets the datum for geographical coordinates interpreted by this elevation source, e.g.
URL	getDemArchiveUrl() Gets the URL of the DEM (ZIP) archive to be used for on-line installaion.
File	getDemInstallDir() Returns the directory (if any) where the DEM files shall be located.
int	getInstallationStatus() Currently not used.
String	getName() The name of this elevation source, e.g.
float	getNoDataValue() Gets the no-data value for this elevation map.
boolean	installDemFiles(Object uiComponent) Asynchronously installs the files required to use the DEM if not already done or in progress.
boolean	isDemInstalled() Tests whether or not the DEM and associated files are installed.
boolean	isInstallingDem() Tests whether or not the DEM is currently being installed.

Field Detail

DEM_INSTALLED

static final int DEM_INSTALLED

See Also:

Constant Field Values

DEM_INSTALLATION_IN_PROGRESS

static final int DEM_INSTALLATION_IN_PROGRESS

See Also:

Constant Field Values

DEM_INSTALLATION_CANCELED

static final int DEM_INSTALLATION_CANCELED

See Also:

Constant Field Values

DEM_INSTALLATION_ERROR

static final int DEM_INSTALLATION_ERROR

See Also:

Constant Field Values

Method Detail

getName

String getName()

The name of this elevation source, e.g. "GTOPO30"

Returns:

a name

getDatum

Datum getDatum()

Gets the datum for geographical coordinates interpreted by this elevation source, e.g. WGS-84.

Returns:

the datum, e.g. Datum.WGS_84

getNoDataValue

float getNoDataValue()

Gets the no-data value for this elevation map.

Returns:

the no-data value, e.g. -99999

createDem

ElevationModel createDem(Resampling resampling)

Creates the elevation model instance.

Parameters:

resampling - The resampling method to be used.

Returns:

a DEM instance, can be null e.g. if related DEM files are not installed

Since:

BEAM 4.6

getDemInstallDir

File getDemInstallDir()

Returns the directory (if any) where the DEM files shall be located.

Returns:

the DEM file directory

getDemArchiveUrl

URL getDemArchiveUrl()

Gets the URL of the DEM (ZIP) archive to be used for on-line installaion.

Returns:

the URL of the DEM (ZIP) archive

isDemInstalled

boolean isDemInstalled()

Tests whether or not the DEM and associated files are installed.

Returns:

true, if so

isInstallingDem

boolean isInstallingDem()

Tests whether or not the DEM is currently being installed.

Returns:

true, if so

installDemFiles

boolean installDemFiles(Object uiComponent)

Asynchronously installs the files required to use the DEM if not already done or in progress.

Parameters:

uiComponent - an optional UI component which serves as parent for progress monitoring

Returns:

true, if the DEM is already installed, is being installed or will be installed. False, if an error occurred or the user canceled the installation

getInstallationStatus

int getInstallationStatus()

Currently not used.