com.luciad.reference

LuciadLightspeedClass TLcdUPSGrid

java.lang.Object

com.luciad.reference.ALcdGeoReference

com.luciad.reference.TLcdGridReference

com.luciad.reference.TLcdUPSGrid

All Implemented Interfaces:

ILcdExtendedModelReference, ILcdModelReference, ILcdGeoReference, ILcdGridReference, ILcdCloneable, ILcdXYWorldReference, ILcdXYZWorldReference, Serializable, Cloneable

public class TLcdUPSGrid
extends TLcdGridReference

This ILcdGridReference represents a UPS grid reference. It is characterized by a boolean flag northPole, which specifies the pole.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.luciad.reference.ILcdGeoReference

CARTESIAN, GEODETIC

Constructor Summary

Constructors

Constructor and Description
TLcdUPSGrid() Creates a new TLcdUPSGrid for the North pole.
TLcdUPSGrid(boolean aNorthPole) Creates a new TLcdUPSGrid for the given pole.

Method Summary

Modifier and Type	Method and Description
String	getName()
boolean	isNorthPole() Returns whether the UPS zone is defined for the North pole, if true, or for the South pole, if false.
void	loadProperties(String aPrefix, Properties aProperties) This method will retrieve the properties of this TLcdUPSGrid, based on the given Properties object and the given prefix.
void	setFalseEasting(double aFalseEasting) Sets the falseEasting of the TLcdGridReference to aFalseEasting.
void	setFalseNorthing(double aFalseNorthing) Sets the falseNorthing of the TLcdGridReference to aFalseNorthing.
void	setNorthPole(boolean aNorthPole) Sets the pole of the UPS zone.
void	setRotation(double aRotation) Sets the rotation of this ILcdGridReference in radians, clockwise.
void	setScale(double aScale) Sets the scale of the TLcdGridReference to aScale.
void	setUnitOfMeasure(double aUnitOfMeasure) Sets the UnitOfMeasure of the TLcdGridReference to aUnitOfMeasure.
void	writePropertiesSFCT(String aPrefix, Properties aPropertiesSFCT) Stores the properties that define this model reference into the specified Properties object as a side effect.

Methods inherited from class com.luciad.reference.TLcdGridReference

clone, equals, get2DEditableBounds, getCoordinateType, getCosRotation, getFalseEasting, getFalseNorthing, getProjection, getRotation, getScale, getSinRotation, getUnitOfMeasure, hashCode, isBoundsAvailable, makeModelPoint, setProjection, toString

Methods inherited from class com.luciad.reference.ALcdGeoReference

getGeodeticDatum, getModelReferenceMetadata, setGeodeticDatum, setModelReferenceMetadata, setName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.reference.ILcdGeoReference

getGeodeticDatum

Constructor Detail

TLcdUPSGrid

public TLcdUPSGrid()

Creates a new TLcdUPSGrid for the North pole.

TLcdUPSGrid

public TLcdUPSGrid(boolean aNorthPole)

Creates a new TLcdUPSGrid for the given pole.

Parameters:

aNorthPole - specifies the North pole, if true, or the South pole, if false.

Method Detail

isNorthPole

public boolean isNorthPole()

Returns whether the UPS zone is defined for the North pole, if true, or for the South pole, if false.

Returns:

whether the UPS zone is defined for the North pole, if true, or for the South pole, if false.

setNorthPole

public void setNorthPole(boolean aNorthPole)

Sets the pole of the UPS zone.

Parameters:

aNorthPole - specifies the North pole, if true, or the South pole, if false.

setFalseEasting

public void setFalseEasting(double aFalseEasting)

Description copied from class: TLcdGridReference

Sets the falseEasting of the TLcdGridReference to aFalseEasting.

Overrides:

setFalseEasting in class TLcdGridReference

Parameters:

aFalseEasting - the new false easting value for this reference (defined in the unit of measure of this reference).

See Also:

TLcdGridReference.getFalseEasting()

setFalseNorthing

public void setFalseNorthing(double aFalseNorthing)

Description copied from class: TLcdGridReference

Sets the falseNorthing of the TLcdGridReference to aFalseNorthing.

Overrides:

setFalseNorthing in class TLcdGridReference

Parameters:

aFalseNorthing - the new false northing value for this reference (defined in the unit of measure of this reference).

See Also:

TLcdGridReference.getFalseNorthing()

setScale

public void setScale(double aScale)

Description copied from class: TLcdGridReference

Sets the scale of the TLcdGridReference to aScale.

Overrides:

setScale in class TLcdGridReference

Parameters:

aScale - the new scale value for this reference.

See Also:

TLcdGridReference.getScale()

setUnitOfMeasure

public void setUnitOfMeasure(double aUnitOfMeasure)

Description copied from class: TLcdGridReference

Sets the UnitOfMeasure of the TLcdGridReference to aUnitOfMeasure.

Overrides:

setUnitOfMeasure in class TLcdGridReference

Parameters:

aUnitOfMeasure - the new unitOfMeasure of this ILcdGridReference w.r.t. meters.

See Also:

TLcdGridReference.getUnitOfMeasure()

setRotation

public void setRotation(double aRotation)

Description copied from class: TLcdGridReference

Sets the rotation of this ILcdGridReference in radians, clockwise. The center of the rotation is the origin of the map projection.

Overrides:

setRotation in class TLcdGridReference

Parameters:

aRotation - the new rotation value for this reference.

See Also:

TLcdGridReference.getRotation()

loadProperties

public void loadProperties(String aPrefix,
                           Properties aProperties)
                    throws IllegalArgumentException

This method will retrieve the properties of this TLcdUPSGrid, based on the given Properties object and the given prefix. The values of following optional keys are retrieved:

• <aPrefix>.TLcdUPSGrid.northPole: true or false (default = true).

By default the geodetic datum will be WGS 84. However, one can optionally set a different geodetic datum by adding entries which will be analyzed by the TLcdGeodeticDatumFactory. The keys of those entries should begin with '<aPrefix>.TLcdUPSGrid.geodeticDatum.'.

Specified by:

loadProperties in interface ILcdModelReference

Overrides:

loadProperties in class TLcdGridReference

Parameters:

aPrefix - a common prefix for all property names that are read.

aProperties - the properties to be parsed.

Throws:

IllegalArgumentException - if the model reference cannot be constructed from the properties.

See Also:

TLcdGeodeticDatumFactory

writePropertiesSFCT

public void writePropertiesSFCT(String aPrefix,
                                Properties aPropertiesSFCT)
                         throws IllegalArgumentException

Description copied from interface: ILcdModelReference

Stores the properties that define this model reference into the specified Properties object as a side effect. Each particular implementation of this interface can define which properties it stores.

Specified by:

writePropertiesSFCT in interface ILcdModelReference

Overrides:

writePropertiesSFCT in class TLcdGridReference

Parameters:

aPrefix - a common prefix for all property names written.

aPropertiesSFCT - the properties that will contain the serialized properties for this model reference, as a side effect.

Throws:

IllegalArgumentException - if the model reference cannot be serialized into properties.

See Also:

loadProperties(java.lang.String, java.util.Properties)

getName

public String getName()

Overrides:

getName in class ALcdGeoReference