Context Navigation

Changeset 13627 in josm

Timestamp:

2018-04-14T16:28:42+02:00 (7 years ago)

Author:

Don-vip

Message:

see #16129 - datum javadoc

Location:

trunk/src/org/openstreetmap/josm/data/projection/datum

Files:

r12453	r13627
8	8	*
9	9	* Adds common fields and access methods.
	10	* @since 4285
10	11	*/
11	12	public abstract class AbstractDatum implements Datum {

-              r8846
+              r13627
  * A datum with different ellipsoid than WGS84, but does not require
  * shift, rotation or scaling.
+ * @since 4285
  */
 public class CentricDatum extends AbstractDatum {
+    /**
+     * Constructs a new {@code CentricDatum}.
+     * @param name Datum name
+     * @param proj4Id proj.4 identifier
+     * @param ellps Ellipsoid. Must be non-null and different from WGS84
+     */
     public CentricDatum(String name, String proj4Id, Ellipsoid ellps) {
         super(name, proj4Id, ellps);

r9243	r13627
9	9	*
10	10	* Basically it provides conversion functions from and to the WGS84 datum.
	11	* @since 4285
11	12	*/
12	13	public interface Datum {

r6883	r13627
9	9	* This datum indicates, that GRS80 ellipsoid is used and no conversion
10	10	* is necessary to get from or to the WGS84 datum.
	11	* @since 4285
11	12	*/
12	13	public final class GRS80Datum extends NullDatum {

r11642	r13627
10	10	/**
11	11	* Datum based of NTV2 grid shift file.
	12	* @since 5073
12	13	*/
13	14	public class NTV2Datum extends AbstractDatum {

-              r13588
+              r13627
  * Modified for JOSM :
  * - removed the RandomAccessFile mode (Pieren)
+ * @since 2507
  */
 public class NTV2GridShiftFile implements Serializable {
 …
+    }
+    /**
+     * Returns "from" ellipsoid identifier.
+     * @return "from" ellipsoid identifier
+     */
     public String getFromEllipsoid() {
         return fromEllipsoid;
+    }
+    /**
+     * Returns "to" ellipsoid identifier.
+     * @return "to" ellipsoid identifier
+     */
     public String getToEllipsoid() {
         return toEllipsoid;

-              r12788
+              r13627
     private final String gridFileName;
+    /** Priority for local NTV2 grid files */
     public static final float NTV2_SOURCE_PRIORITY_LOCAL = 10f;
+    /** Priority for downloaded NTV2 grid files */
     public static final float NTV2_SOURCE_PRIORITY_DOWNLOAD = 5f;

-              r12620
+              r13627
 /**
  * Models the NTv2 Sub Grid within a Grid Shift File
+ * Models the NTv2 Sub Grid within a Grid Shift File.
+ *
  * @author Peter Yuill
 …
  *   file reading by group of 4 bytes from a jar file.
  * - removed the Cloneable interface
+ * @since 2507
  */
 public class NTV2SubGrid implements Serializable {
 …
+    }
+    /**
+     * Returns the parent sub grid name.
+     * @return the parent sub grid name
+     */
     public String getParentSubGridName() {
         return parentSubGridName;
+    }
+    /**
+     * Returns the sub grid name.
+     * @return the sub grid name
+     */
     public String getSubGridName() {
         return subGridName;
+    }
+    /**
+     * Returns the node count.
+     * @return the node count
+     */
     public int getNodeCount() {
         return nodeCount;
+    }
+    /**
+     * Returns the sub grid count.
+     * @return the sub grid count
+     */
     public int getSubGridCount() {
         return subGrid == null ? 0 : subGrid.length;

-              r7937
+              r13627
 /**
  * Null Datum does not convert from / to WGS84 ellipsoid, but simply "casts"
  * the coordinates.
+ * Null Datum does not convert from / to WGS84 ellipsoid, but simply "casts" the coordinates.
+ * @since 4285
  */
 public class NullDatum extends AbstractDatum {
+    /**
+     * Constructs a new {@code NullDatum}.
+     * @param name name of the datum
+     * @param ellps the ellipsoid used
+     */
     public NullDatum(String name, Ellipsoid ellps) {
         super(name, null, ellps);

-              r12279
+              r13627
  * This method is described by EPSG as EPSG:9606.
  * Also known as Bursa-Wolf.
+ * @since 4285
  */
 public class SevenParameterDatum extends AbstractDatum {
 …
     /**
+     *
+     * Constructs a new {@code SevenParameterDatum}
      * @param name name of the datum
      * @param proj4Id Proj.4 identifier for this datum (or null)

-              r6069
+              r13627
 /**
  * Datum provides 3 dimensional offset and ellipsoid conversion.
+ * @since 4285
  */
 public class ThreeParameterDatum extends AbstractDatum {
 …
     protected double dx, dy, dz;
+    /**
+     * Constructs a new {@code ThreeParameterDatum}.
+     * @param name name of the datum
+     * @param proj4Id Proj.4 identifier for this datum (or null)
+     * @param ellps the ellipsoid used
+     * @param dx x offset in meters
+     * @param dy y offset in meters
+     * @param dz z offset in meters
+     */
     public ThreeParameterDatum(String name, String proj4Id, Ellipsoid ellps, double dx, double dy, double dz) {
         super(name, proj4Id, ellps);

-              r6362
+              r13627
 /**
  * WGS84 datum. Transformation from and to WGS84 datum is a no-op.
+ * @since 4285
  */
 public final class WGS84Datum extends NullDatum {
+    /**
+     * The unique instance.
+     */
     public static final WGS84Datum INSTANCE = new WGS84Datum();

Note: See TracChangeset for help on using the changeset viewer.