com.supermap.data

Class PrjParameter

  • java.lang.Object
    • com.supermap.data.PrjParameter


  • public class PrjParameter
    extends java.lang.Object

    The projection parameter class.

    The projection parameters, such as the prime meridian, the central parallel, the first and second standard parallels. etc.

    • Constructor Detail

      • PrjParameter

        public PrjParameter()
        Constructs a new PrjParameter object.
      • PrjParameter

        public PrjParameter(PrjParameter prjParameter)
        Constructs a new object identical to the given PrjParameter object.
        Parameters:
        prjParameter - The specified prjParameter object.
    • Method Detail

      • getFalseEasting

        public double getFalseEasting()
        Returns the false easting of the coordinates.

        The return value of the method is an offset for avoiding negative value in coordinate system which is usually used in Gauss-Kruger, UTM and Mercator projections. The value is 500,000 meters commonly.

        Returns:
        The false easting of the coordinates.
        Default:
        The default value is 0.
      • setFalseEasting

        public void setFalseEasting(double value)
        Sets the false easting of the coordinates.

        The return value of the method is an offset for avoiding negative value in coordinate system which is usually used in Gauss-Kruger, UTM and Mercator projections. The value is 500,000 meters commonly.

        Parameters:
        value - The false easting of the coordinates.
      • getFalseNorthing

        public double getFalseNorthing()
        Returns the false northing of the coordinates.

        The return value of the method is an offset for avoiding negative value in coordinate system which is usually used in Gauss-Kruger, UTM and Mercator projections. The value is 1,000,000 meters commonly.

        Returns:
        The false northing of the coordinates.
        Default:
        The default value is 0.
      • setFalseNorthing

        public void setFalseNorthing(double value)
        Sets the false northing of the coordinates.

        The return value of the method is an offset for avoiding negative value in coordinate system which is usually used in Gauss-Kruger, UTM and Mercator projections. The value is 1,000,000 meters commonly.

        Parameters:
        value - The false northing of the coordinates.
      • getCentralMeridian

        public double getCentralMeridian()
        Returns the central meridian.

        The range of value is from -180 to 180, in degrees.

        Returns:
        The central meridian.
        Default:
        The default value is 0.
      • setCentralMeridian

        public void setCentralMeridian(double value)
        Sets the central meridian value.

        The range of value is from -180 to 180, in degrees.

        Parameters:
        value - The central meridian.
      • getCentralParallel

        public double getCentralParallel()
        Returns the latitude of the original point.

        The value ranges from -90 degree to 90 degree. In the conical projection, it usually is the latitude of the southernmost point in the projection area.

        Returns:
        The central parallel.
        Default:
        The default value is 0.
      • setCentralParallel

        public void setCentralParallel(double value)
        The the latitude of the original point.

        The value ranges from -90 degree to 90 degree. In the conical projection, it usually is the latitude of the southernmost point in the projection area.

        Parameters:
        value - The central parallel.
      • getStandardParallel1

        public double getStandardParallel1()
        Returns the latitude of the first standard parallel.

        It is mainly used in conic projection. If it is single parallel, the first and second parallels are equal.

        Returns:
        The first standard parallel.
        Default:
        The default value is 0.
      • setStandardParallel1

        public void setStandardParallel1(double value)
        Sets the latitude of the first standard parallel.

        It is mainly used in conic projection. If it is single parallel, the first and second parallels are equal.

        Parameters:
        value - The first standard parallel.
      • getStandardParallel2

        public double getStandardParallel2()
        Returns the latitude of the second standard parallel.

        It is mainly used in conic projection. If it is single parallel, the first and second parallels are equal; If it is dual parallels, the second one can not equal with the first one.

        Returns:
        The second standard parallel.
        Default:
        The default value is 0.
      • setStandardParallel2

        public void setStandardParallel2(double value)
        Sets the second standard parallel.

        It is mainly used in conic projection. If it is single parallel, the first and second parallels are equal; If it is dual parallels, the second one can not equal with the first one.

        Parameters:
        value - The second standard parallel.
      • getScaleFactor

        public double getScaleFactor()
        Returns the scale factor for the projection transformation.

        It is used to decrease the error in projection conversion. The value of Mercator, Gauss-Kruger and UTM projections is 0.9996.

        Returns:
        The scale factor for the projection transformation.
        Default:
        The default value is 0.
      • setScaleFactor

        public void setScaleFactor(double value)
        Sets the scale factor for the projection transformation.

        It is used to decrease the error in projection conversion. The value of Mercator, Gauss-Kruger and UTM projections is 0.9996.

        Parameters:
        value - The scale factor for the projection transformation.
      • getAzimuth

        public double getAzimuth()
        Returns the azimuth, mainly used in oblique projection.
        Returns:
        the azimuth.
        Default:
        The default value is 0.
      • setAzimuth

        public void setAzimuth(double value)
        Sets the azimuth, mainly used in oblique projection.
        Parameters:
        value - the azimuth.
      • getFirstPointLongitude

        public double getFirstPointLongitude()
        Returns the longitude of the first point. Used in azimuthal projection or oblique projection.
        Returns:
        The longitude of the first point.
        See Also:
        getSecondPointLongitude()
        Default:
        The default value is 0.
      • setFirstPointLongitude

        public void setFirstPointLongitude(double value)
        Sets the longitude of the first point. Used in azimuthal projection or oblique projection.
        Parameters:
        value - The longitude of the first point.
        See Also:
        setSecondPointLongitude(double)
      • getSecondPointLongitude

        public double getSecondPointLongitude()
        Returns the longitude of the second point. Used in azimuthal projection or oblique projection.
        Returns:
        The longitude of the second point.
        See Also:
        getFirstPointLongitude()
        Default:
        The default value is 0.
      • setSecondPointLongitude

        public void setSecondPointLongitude(double value)
        Sets the longitude of the second point. Used in azimuthal projection or oblique projection.
        Parameters:
        value - The longitude of the second point.
        See Also:
        setFirstPointLongitude(double)
      • dispose

        public void dispose()
        Disposes the resource occupy by this object.
      • clone

        public PrjParameter clone()
        Clones the object itself.
        Overrides:
        clone in class java.lang.Object
        Returns:
        Returns the clone of this object.
      • fromXML

        public boolean fromXML(java.lang.String xml)
        Constructs a PrjParameter object with the introduced xml string.
        Parameters:
        xml - The XML string passed in.
        Returns:
        Returns true, if successful; otherwise, false.
      • toXML

        public java.lang.String toXML()
        Returns an xml string that represents the PrjParameter object.
        Returns:
        An xml string that represents the PrjParameter object.