Class TLcdLambertFrenchGridReference

All Implemented Interfaces:
ILcdExtendedModelReference, ILcdModelReference, ILcdGeoReference, ILcdGridReference, ILcdCloneable, ILcdXYWorldReference, ILcdXYZWorldReference, Serializable, Cloneable

public final class TLcdLambertFrenchGridReference extends TLcdGridReference implements ILcdGridReference, ILcdModelReference
This ILcdGridReference implements the french grid system. The ellipsoid is based on the international Hayford 1924 ellipsoid. The geodetic datum is the NTF geodetic datum. The projection is a Lambert Conformal Conic projection with the appropriate parameters.
See Also:
  • Constructor Details

    • TLcdLambertFrenchGridReference

      public TLcdLambertFrenchGridReference()
      Default constructor constructs the french grid system for zone II etendu, which can also be used for the whole of France, with the zone number prefixed to the false northing.
    • TLcdLambertFrenchGridReference

      public TLcdLambertFrenchGridReference(int aZoneID)
      Creates a French grid reference for the given zone, with the zone number prefixed to the false northing. Zones I, II, and III are within France. Zone IV is Corse.
      Zone II etendu can be specified by passing 0 as the zone number.
      Parameters:
      aZoneID - the zone ID of the french grid system.
    • TLcdLambertFrenchGridReference

      public TLcdLambertFrenchGridReference(int aZoneID, boolean aCarto)
      Creates a French grid reference for the given zone, optionally with the zone number prefixed to the false northing. Zones I, II, and III are within France. Zone IV is Corse.
      Zone II etendu can be specified by passing 0 as the zone number.
      Parameters:
      aZoneID - the zone ID of the french grid system.
      aCarto - specifies whether the zone number should be prefixed to the false northing.
  • Method Details

    • loadProperties

      public void loadProperties(String aPrefix, Properties aProperties) throws IllegalArgumentException
      Retrieve parameters of this TLcdLambertFrenchGridReference (i.e., the zone number) from a Properties object. Loads the property of a TLcdLambertFrenchGridReference: the zone id for the French grid reference. This method will, given aPrefix, analyze the aProperties object to set the properties of this TLcdLambertFrenchGridReference. The values of following keys are retrieved:
      • <aPrefix><the name of the class that extends this abstract class>.zone
      • <aPrefix><the name of the class that extends this abstract class>.carto
      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
      Writes the properties of a TLcdLambertFrenchGridReference: the zone id of the french grid system. This method will, given aPrefix, store the properties of this TLcdLambertFrenchGridReference into the aProperties object. The values of following keys are stored:
      • <aPrefix><the name of the class that extends this abstract class>.zone
      • <aPrefix><the name of the class that extends this abstract class>.carto
      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:
    • setZoneID

      public void setZoneID(int aZoneID)
      Sets the zone ID of the french grid system to aZone. Zones I, II, and III are within France. Zone IV is Corse. Passing 0 for the aZone results in Zone II etendu, used for the whole of France.
      Parameters:
      aZoneID - the zone ID of the french grid system.
      See Also:
    • getZoneID

      public int getZoneID()
      Gets the zone ID of the french grid system. Zones I, II, and III are within France. Zone IV is Corse. Zone ID 0 corresponds to Zone II etendu, used for the whole of France.
      Returns:
      the zone ID of the french grid system.
      See Also:
    • setCarto

      public void setCarto(boolean aCarto)
      Specifies whether the zone number should be prefixed to the false northing.
      Parameters:
      aCarto - specifies whether the zone number should be prefixed to the false northing.
      See Also:
    • isCarto

      public boolean isCarto()
      Returns whether the zone number is prefixed to the false northing.
      Returns:
      whether the zone number should be prefixed to the false northing.
      See Also:
    • getName

      public String getName()
      Overrides:
      getName in class ALcdGeoReference