com.luciad.lucy.addons.modelreference

LuciadLightspeedClass TLcyUTMGridReference

java.lang.Object

com.luciad.reference.ALcdGeoReference

com.luciad.reference.TLcdGridReference

com.luciad.lucy.addons.modelreference.TLcyGridReference

com.luciad.lucy.addons.modelreference.TLcyUTMGridReference

All Implemented Interfaces:

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

public class TLcyUTMGridReference
extends TLcyGridReference

Note: Do not programmatically rely on the existence of this class or its methods, as they might change or disappear without notice.

If an UTM reference is needed, use TLcdUTMGrid instead.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.luciad.reference.ILcdGeoReference

CARTESIAN, GEODETIC

Constructor Summary

Constructors

Constructor and Description
TLcyUTMGridReference() Creates a new TLcyUTMGridReference.
TLcyUTMGridReference(ILcdGeodeticDatum aGeodeticDatum, ILcdProjection aProjection, double aFalseEasting, double aFalseNorthing, double aScale, double aUnitOfMeasure, double aRotation, int aZoneID, boolean aNorthernHemisphere)
TLcyUTMGridReference(int aZoneID, boolean aNorthernHemisphere) Creates a new TLcdUTMGrid for the given zone and on the given hemisphere.
TLcyUTMGridReference(TLcdUTMGrid aUTMGridReference, String aDisplayName, boolean aEditable) Creates a new TLcyUTMGridReference, ready to be used.
TLcyUTMGridReference(TLcyUTMGridReference aUTMGridReference) Copy constructor.

Method Summary

Modifier and Type	Method and Description
int	getZoneID()
boolean	isNorthernHemisphere()
void	loadProperties(String aPrefix, Properties aProperties) This method will, given aPrefix, analyze the Properties object aProperties to set the properties of this TLcdGridReference.
void	setNorthernHemisphere(boolean aNorthernHemisphere)
void	setZoneID(int aZoneID)
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.lucy.addons.modelreference.TLcyGridReference

clone, equals, getDisplayName, hashCode, isEditable, setDisplayName, setEditable, toString

Methods inherited from class com.luciad.reference.TLcdGridReference

get2DEditableBounds, getCoordinateType, getCosRotation, getFalseEasting, getFalseNorthing, getProjection, getRotation, getScale, getSinRotation, getUnitOfMeasure, isBoundsAvailable, makeModelPoint, setFalseEasting, setFalseNorthing, setProjection, setRotation, setScale, setUnitOfMeasure

Methods inherited from class com.luciad.reference.ALcdGeoReference

getGeodeticDatum, getModelReferenceMetadata, getName, 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

TLcyUTMGridReference

public TLcyUTMGridReference()

Creates a new TLcyUTMGridReference. You will have to set a geodetic datum and a projection before the grid reference can be used.

TLcyUTMGridReference

public TLcyUTMGridReference(int aZoneID,
                            boolean aNorthernHemisphere)

Creates a new TLcdUTMGrid for the given zone and on the given hemisphere.

Parameters:

aZoneID - the zone ID of the UTM grid to use.

aNorthernHemisphere - specifies that the zone lies in the northern hemisphere, if true, or in the southern hemisphere, if false.

TLcyUTMGridReference

public TLcyUTMGridReference(TLcyUTMGridReference aUTMGridReference)

Copy constructor.

Parameters:

aUTMGridReference - The grid reference to copy.

See Also:

TLcdGridReference

TLcyUTMGridReference

public TLcyUTMGridReference(ILcdGeodeticDatum aGeodeticDatum,
                            ILcdProjection aProjection,
                            double aFalseEasting,
                            double aFalseNorthing,
                            double aScale,
                            double aUnitOfMeasure,
                            double aRotation,
                            int aZoneID,
                            boolean aNorthernHemisphere)

TLcyUTMGridReference

public TLcyUTMGridReference(TLcdUTMGrid aUTMGridReference,
                            String aDisplayName,
                            boolean aEditable)

Creates a new TLcyUTMGridReference, ready to be used. All necessary properties are taken from the given TLcdUTMGrid.

Parameters:

aUTMGridReference - The TLcdUTMGrid to take all properties from.

aDisplayName - The display name for this grid reference.

aEditable - True if this grid reference can be modified, false otherwise.

See Also:

TLcdGridReference

Method Detail

setZoneID

public void setZoneID(int aZoneID)

setNorthernHemisphere

public void setNorthernHemisphere(boolean aNorthernHemisphere)

isNorthernHemisphere

public boolean isNorthernHemisphere()

getZoneID

public int getZoneID()

loadProperties

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

Description copied from class: TLcdGridReference

This method will, given aPrefix, analyze the Properties object aProperties to set the properties of this TLcdGridReference. The values of following keys are retrieved:

• <aPrefix>.TLcdGridReference.scale
• <aPrefix>.TLcdGridReference.falseNorthing
• <aPrefix>.TLcdGridReference.falseEasting
• <aPrefix>.TLcdGridReference.unitOfMeasure
• <aPrefix>.TLcdGridReference.rotation

To be able to set the property projection aProperties should contain entries which will be analyzed by the TLcdProjectionFactory. The keys of those entries should begin with '<aPrefix>TLcdGridReference.projection.'.

To be able to set the property geodeticDatum the aProperties should contain entries which will be analyzed by the TLcdGeodeticDatumFactory. The keys of those entries should begin with '<aPrefix>.TLcdGridReference.geodeticDatum.'. The properties object is also passed to the TLcdModelReferenceMetadata.loadProperties(java.lang.String, java.util.Properties) with the prefix "<aPrefix>.TLcdGridReference."

Specified by:

loadProperties in interface ILcdModelReference

Overrides:

loadProperties in class TLcyGridReference

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:

TLcdProjectionFactory, TLcdGeodeticDatumFactory, TLcdModelReferenceMetadata

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 TLcyGridReference

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:

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