ilog.views.maps
Class IlvAltitudeProvider

java.lang.Object
  ilog.views.maps.IlvAltitudeProvider

All Implemented Interfaces:

IlvPersistentObject

Direct Known Subclasses:

IlvDefaultAltitudeProvider

public abstract class IlvAltitudeProvider
extends Object
implements IlvPersistentObject

This abstract class defines the methods necessary to provide altitude data to consumers. Its subclasses should provide serialization methods for saving the map. The most important method to implement in subclasses will provide the manager with capabilities to retrieve altitude data from a longitude and latitude, and possibly a precision around that central point.

Since:

JViews 7.5

See Also:

IlvDefaultAltitudeProvider

Constructor Summary

IlvAltitudeProvider()
Creates a new IlvAltitudeProvider.

Method Summary

abstract IlvAltitudeProvider	copy() /** Returns A new IlvAltitudeProvider.
abstract double	getAltitude(IlvManager manager, double xlon, double ylat, double precision) Return the altitude of a point located at specified coordinates.
abstract void	write(IlvOutputStream stream) Writes the attributes of a persistent object.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvAltitudeProvider

public IlvAltitudeProvider()

Creates a new IlvAltitudeProvider.

Method Detail

getAltitude

public abstract double getAltitude(IlvManager manager,
                                   double xlon,
                                   double ylat,
                                   double precision)

Return the altitude of a point located at specified coordinates. If there's no altitude for specified point it returns NaN.

Parameters:

manager - Manager to use for finding altitude providing graphics.

xlon - Longitude in radians.

ylat - Latitude in radians.

precision - Coordinate precision.

Returns:

double Altitude of the point.

copy

public abstract IlvAltitudeProvider copy()

/** Returns A new IlvAltitudeProvider.

Returns:

Returns A new IlvAltitudeProvider.

write

public abstract void write(IlvOutputStream stream)
                    throws IOException

Writes the attributes of a persistent object.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - the output stream

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

See Also:

IlvPersistentObject.write(ilog.views.io.IlvOutputStream)