com.luciad.view.map

LuciadLightspeedClass TLcdUPSGridSystem

java.lang.Object

com.luciad.view.map.TLcdUPSGridSystem

public class TLcdUPSGridSystem
extends Object

This class can be used to retrieve a TLcdUPSGrid reference for a specific point or hemisphere.

Since:

11.0

Constructor Summary

Constructors

Constructor and Description
TLcdUPSGridSystem() Creates a new TLcdUPSGridSystem for the WGS84 geodetic datum.
TLcdUPSGridSystem(ILcdGeodeticDatum aGeodeticDatum) Creates a new TLcdUPSGridSystem for the given geodetic datum.

Method Summary

Modifier and Type	Method and Description
ILcdGeodeticDatum	getGeodeticDatum() Returns the used geodetic datum.
TLcdUPSGrid	getUPSGrid(boolean aNorth) Returns the TLcdUPSGrid for the given zone.
TLcdUPSGrid	getUPSGrid(ILcdPoint aLLP) Returns the TLcdUPSGrid for the given lon lat point.
static boolean	inLonLatBounds(ILcdPoint aLLP) Checks if an ILcdPoint is inside the valid area of the UPS grid system.
static boolean	retrieveZone(ILcdPoint aLLP) Returns the UPS zone for the given point.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdUPSGridSystem

public TLcdUPSGridSystem()

Creates a new TLcdUPSGridSystem for the WGS84 geodetic datum. The TLcdUPSGrid instances returned by this class will contain this datum.

TLcdUPSGridSystem

public TLcdUPSGridSystem(ILcdGeodeticDatum aGeodeticDatum)

Creates a new TLcdUPSGridSystem for the given geodetic datum. The TLcdUPSGrid instances returned by this class will contain this datum.

Parameters:

aGeodeticDatum - a geodetic datum.

Method Detail

getGeodeticDatum

public ILcdGeodeticDatum getGeodeticDatum()

Returns the used geodetic datum.

Returns:

the used geodetic datum.

getUPSGrid

public TLcdUPSGrid getUPSGrid(boolean aNorth)

Returns the TLcdUPSGrid for the given zone.

Parameters:

aNorth - true to return the ups grid for the northern hemisphere, and false otherwise.

Returns:

the TLcdUPSGrid for the given zone.

getUPSGrid

public TLcdUPSGrid getUPSGrid(ILcdPoint aLLP)
                       throws TLcdOutOfBoundsException

Returns the TLcdUPSGrid for the given lon lat point.

Parameters:

aLLP - a given lon lat point.

Returns:

the TLcdUPSGrid for the given lon lat point

Throws:

TLcdOutOfBoundsException - when the given lon lat point is outside the bounds of the UPS grid system.

retrieveZone

public static boolean retrieveZone(ILcdPoint aLLP)
                            throws TLcdOutOfBoundsException

Returns the UPS zone for the given point. When the returned value is true, the UPS zone is the northern zone. If the returned value is false, it is the southern zone.

Parameters:

aLLP - a given lon lat point.

Returns:

the UPS zone for the given point.

Throws:

TLcdOutOfBoundsException - when the given lon lat point is outside the bounds of the UPS grid system.

inLonLatBounds

public static boolean inLonLatBounds(ILcdPoint aLLP)

Checks if an ILcdPoint is inside the valid area of the UPS grid system.

Parameters:

aLLP - the point to check for.

Returns:

true if the y value of the given point is larger than or equal to TLcdUTMGridSystem.NORTH_LAT_LIMIT or smaller than of equal to TLcdUTMGridSystem.SOUTH_LAT_LIMIT.