Changeset 13627 in josm


Ignore:
Timestamp:
2018-04-14T16:28:42+02:00 (5 months ago)
Author:
Don-vip
Message:

see #16129 - datum javadoc

Location:
trunk/src/org/openstreetmap/josm/data/projection/datum
Files:
12 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/projection/datum/AbstractDatum.java

    r12453 r13627  
    88 *
    99 * Adds common fields and access methods.
     10 * @since 4285
    1011 */
    1112public abstract class AbstractDatum implements Datum {
  • trunk/src/org/openstreetmap/josm/data/projection/datum/CentricDatum.java

    r8846 r13627  
    88 * A datum with different ellipsoid than WGS84, but does not require
    99 * shift, rotation or scaling.
     10 * @since 4285
    1011 */
    1112public class CentricDatum extends AbstractDatum {
    1213
     14    /**
     15     * Constructs a new {@code CentricDatum}.
     16     * @param name Datum name
     17     * @param proj4Id proj.4 identifier
     18     * @param ellps Ellipsoid. Must be non-null and different from WGS84
     19     */
    1320    public CentricDatum(String name, String proj4Id, Ellipsoid ellps) {
    1421        super(name, proj4Id, ellps);
  • trunk/src/org/openstreetmap/josm/data/projection/datum/Datum.java

    r9243 r13627  
    99 *
    1010 * Basically it provides conversion functions from and to the WGS84 datum.
     11 * @since 4285
    1112 */
    1213public interface Datum {
  • trunk/src/org/openstreetmap/josm/data/projection/datum/GRS80Datum.java

    r6883 r13627  
    99 * This datum indicates, that GRS80 ellipsoid is used and no conversion
    1010 * is necessary to get from or to the WGS84 datum.
     11 * @since 4285
    1112 */
    1213public final class GRS80Datum extends NullDatum {
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2Datum.java

    r11642 r13627  
    1010/**
    1111 * Datum based of NTV2 grid shift file.
     12 * @since 5073
    1213 */
    1314public class NTV2Datum extends AbstractDatum {
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2GridShiftFile.java

    r13588 r13627  
    6363 * Modified for JOSM :
    6464 * - removed the RandomAccessFile mode (Pieren)
     65 * @since 2507
    6566 */
    6667public class NTV2GridShiftFile implements Serializable {
     
    299300    }
    300301
     302    /**
     303     * Returns "from" ellipsoid identifier.
     304     * @return "from" ellipsoid identifier
     305     */
    301306    public String getFromEllipsoid() {
    302307        return fromEllipsoid;
    303308    }
    304309
     310    /**
     311     * Returns "to" ellipsoid identifier.
     312     * @return "to" ellipsoid identifier
     313     */
    305314    public String getToEllipsoid() {
    306315        return toEllipsoid;
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2GridShiftFileWrapper.java

    r12788 r13627  
    1919    private final String gridFileName;
    2020
     21    /** Priority for local NTV2 grid files */
    2122    public static final float NTV2_SOURCE_PRIORITY_LOCAL = 10f;
     23    /** Priority for downloaded NTV2 grid files */
    2224    public static final float NTV2_SOURCE_PRIORITY_DOWNLOAD = 5f;
    2325
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java

    r12620 r13627  
    2929
    3030/**
    31  * Models the NTv2 Sub Grid within a Grid Shift File
     31 * Models the NTv2 Sub Grid within a Grid Shift File.
    3232 *
    3333 * @author Peter Yuill
     
    3737 *   file reading by group of 4 bytes from a jar file.
    3838 * - removed the Cloneable interface
     39 * @since 2507
    3940 */
    4041public class NTV2SubGrid implements Serializable {
     
    261262    }
    262263
     264    /**
     265     * Returns the parent sub grid name.
     266     * @return the parent sub grid name
     267     */
    263268    public String getParentSubGridName() {
    264269        return parentSubGridName;
    265270    }
    266271
     272    /**
     273     * Returns the sub grid name.
     274     * @return the sub grid name
     275     */
    267276    public String getSubGridName() {
    268277        return subGridName;
    269278    }
    270279
     280    /**
     281     * Returns the node count.
     282     * @return the node count
     283     */
    271284    public int getNodeCount() {
    272285        return nodeCount;
    273286    }
    274287
     288    /**
     289     * Returns the sub grid count.
     290     * @return the sub grid count
     291     */
    275292    public int getSubGridCount() {
    276293        return subGrid == null ? 0 : subGrid.length;
  • trunk/src/org/openstreetmap/josm/data/projection/datum/NullDatum.java

    r7937 r13627  
    66
    77/**
    8  * Null Datum does not convert from / to WGS84 ellipsoid, but simply "casts"
    9  * the coordinates.
     8 * Null Datum does not convert from / to WGS84 ellipsoid, but simply "casts" the coordinates.
     9 * @since 4285
    1010 */
    1111public class NullDatum extends AbstractDatum {
    1212
     13    /**
     14     * Constructs a new {@code NullDatum}.
     15     * @param name name of the datum
     16     * @param ellps the ellipsoid used
     17     */
    1318    public NullDatum(String name, Ellipsoid ellps) {
    1419        super(name, null, ellps);
  • trunk/src/org/openstreetmap/josm/data/projection/datum/SevenParameterDatum.java

    r12279 r13627  
    1616 * This method is described by EPSG as EPSG:9606.
    1717 * Also known as Bursa-Wolf.
     18 * @since 4285
    1819 */
    1920public class SevenParameterDatum extends AbstractDatum {
     
    2223
    2324    /**
    24      *
     25     * Constructs a new {@code SevenParameterDatum}
    2526     * @param name name of the datum
    2627     * @param proj4Id Proj.4 identifier for this datum (or null)
  • trunk/src/org/openstreetmap/josm/data/projection/datum/ThreeParameterDatum.java

    r6069 r13627  
    77/**
    88 * Datum provides 3 dimensional offset and ellipsoid conversion.
     9 * @since 4285
    910 */
    1011public class ThreeParameterDatum extends AbstractDatum {
     
    1213    protected double dx, dy, dz;
    1314
     15    /**
     16     * Constructs a new {@code ThreeParameterDatum}.
     17     * @param name name of the datum
     18     * @param proj4Id Proj.4 identifier for this datum (or null)
     19     * @param ellps the ellipsoid used
     20     * @param dx x offset in meters
     21     * @param dy y offset in meters
     22     * @param dz z offset in meters
     23     */
    1424    public ThreeParameterDatum(String name, String proj4Id, Ellipsoid ellps, double dx, double dy, double dz) {
    1525        super(name, proj4Id, ellps);
  • trunk/src/org/openstreetmap/josm/data/projection/datum/WGS84Datum.java

    r6362 r13627  
    88/**
    99 * WGS84 datum. Transformation from and to WGS84 datum is a no-op.
     10 * @since 4285
    1011 */
    1112public final class WGS84Datum extends NullDatum {
    1213
     14    /**
     15     * The unique instance.
     16     */
    1317    public static final WGS84Datum INSTANCE = new WGS84Datum();
    1418
Note: See TracChangeset for help on using the changeset viewer.