Package com.luciad.reference

Class TLcdUTMGrid

java.lang.Object
com.luciad.reference.ALcdGeoReference
com.luciad.reference.TLcdGridReference
com.luciad.reference.TLcdUTMGrid
All Implemented Interfaces:
ILcdExtendedModelReference, ILcdModelReference, ILcdGeoReference, ILcdGridReference, ILcdCloneable, ILcdXYWorldReference, ILcdXYZWorldReference, Serializable, Cloneable
public class TLcdUTMGrid extends TLcdGridReference
This ILcdGridReference represents a UTM grid reference. It is characterized by zoneID, which is a value between 1 and 60, inclusive, and a boolean flag northernHemisphere, which specifies the hemisphere. Zone n corresponds to the region with longitudes ranging from 6*(n-31) degrees to * 6*(n-30) degrees.
See Also:

  • Constructor Details

    • TLcdUTMGrid

      public TLcdUTMGrid()
      Creates a new TLcdUTMGrid for zone 30 on the northern hemisphere.

    • TLcdUTMGrid

      public TLcdUTMGrid(int aZoneID)
      Creates a new TLcdUTMGrid for the given zone on the northern hemisphere.
      Parameters:
      aZoneID - the zone ID of the UTM grid to use.

    • TLcdUTMGrid

      public TLcdUTMGrid(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.

  • Method Details

    • setProjection

      public void setProjection(ILcdProjection aProjection)
      Description copied from class: TLcdGridReference
      Sets the ILcdProjection of the TLcdGridReference to aProjection.
      Overrides:
      setProjection in class TLcdGridReference
      Parameters:
      aProjection - the new projection value for this reference.
      See Also:

    • setGeodeticDatum

      public void setGeodeticDatum(ILcdGeodeticDatum aGeodeticDatum)
      Description copied from class: ALcdGeoReference
      Sets the geodetic datum this reference is based on.
      Overrides:
      setGeodeticDatum in class ALcdGeoReference
      Parameters:
      aGeodeticDatum - the geodetic datum this reference is based on.
      See Also:

    • getZoneID

      public int getZoneID()
      Returns the zone ID that identifies the UTM zone. The ID lies between 1 and 60.
      Returns:
      the zone ID of this TLcdUTMGrid.
      See Also:

    • setZoneID

      public void setZoneID(int aZoneID)
      Sets the zoneID of this TLcdUTMGrid.
      Parameters:
      aZoneID - the new zone ID of this TLcdUTMGrid. The zone ID lies between 1 and 60.
      See Also:

    • getCentralMeridian

      public double getCentralMeridian()
      Gets the central meridian of the current TLcdUTMGrid.
      Returns:
      the central meridian of the current TLcdUTMGrid.

    • isNorthernHemisphere

      public boolean isNorthernHemisphere()
      Returns whether the UTM zone lies in the northern hemisphere, if true, or in the southern hemisphere, if false.
      Returns:
      whether the UTM zone lies in the northern hemisphere, if true, or in the southern hemisphere, if false.

    • setNorthernHemisphere

      public void setNorthernHemisphere(boolean aNorthernHemisphere)
      Sets the hemisphere of the UTM zone.
      Parameters:
      aNorthernHemisphere - specifies that the zone lies in the northern hemisphere, if true, or in the southern hemisphere, 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • loadProperties

      public void loadProperties(String aPrefix, Properties aProperties) throws IllegalArgumentException
      This method will retrieve the properties of this TLcdUTMGrid, based on the given Properties object and the given prefix. The values of following required keys are retrieved:
      • <aPrefix>.TLcdUTMGrid.zoneID
      The values of following optional keys are retrieved:
      • <aPrefix>.TLcdUTMGrid.northernHemisphere: 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>.TLcdUTMGrid.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:

    • 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:

    • setName

      public void setName(String aName)
      Sets a textual description of this reference.
      Overrides:
      setName in class ALcdGeoReference
      Parameters:
      aName - a textual description of this reference.
      See Also:

    • getName

      public String getName()
      Returns a textual description of this reference. If none was set using setName, a string containing the zone, the hemisphere and the geodetic datum is returned.
      Overrides:
      getName in class ALcdGeoReference
      Returns:
      a textual description of this reference
      See Also:

    • toString

      public String toString()
      Description copied from class: TLcdGridReference
      Returns the name of this grid reference if it is defined, calls super.toString otherwise.
      Overrides:
      toString in class TLcdGridReference
      Returns:
      the name of this grid reference if it is defined.

    • clone

      public Object clone()
      Description copied from class: TLcdGridReference
      Makes a deep clone of this grid reference.
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class TLcdGridReference
      See Also: