org.cts.datum.AbstractDatum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cts Show documentation

Coordinate Transformation Suite (abridged CTS) is a library developed to perform coordinate transformations using well known geodetic algorithms and parameter sets. It strives to be simple, flexible and interoperable, in this order.

There is a newer version: 1.7.1

Show newest version

/*
 * Coordinate Transformations Suite (abridged CTS)  is a library developped to 
 * perform Coordinate Transformations using well known geodetic algorithms 
 * and parameter sets. 
 * Its main focus are simplicity, flexibility, interoperability, in this order.
 *
 * This library has been originally developed by Michaël Michaud under the JGeod
 * name. It has been renamed CTS in 2009 and shared to the community from 
 * the Atelier SIG code repository.
 * 
 * Since them, CTS is supported by the Atelier SIG team in collaboration with Michaël 
 * Michaud.
 * The new CTS has been funded  by the French Agence Nationale de la Recherche 
 * (ANR) under contract ANR-08-VILL-0005-01 and the regional council 
 * "Région Pays de La Loire" under the projet SOGVILLE (Système d'Orbservation 
 * Géographique de la Ville).
 *
 * CTS is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * CTS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * CTS. If not, see .
 *
 * For more information, please consult: 
 */
package org.cts.datum;

import org.cts.IdentifiableComponent;
import org.cts.Identifier;
import org.cts.cs.Extent;

/**
 * A datum (plural datums) is a reference from which measurements are made.
 * In surveying and geodesy, a datum is a reference point on the earth's surface
 * against which position measurements are made, and an associated model of the
 * shape of the earth for computing positions. Horizontal datums are used for
 * describing a point on the earth's surface, in latitude and longitude or
 * another coordinate system. Vertical datums are used to measure elevations or
 * underwater depths. In engineering and drafting, a datum is a reference point,
 * surface, or axis on an object against which measurements are made.
 (Taken
 * from wikipedia on
 * 2006-10-06)
 *
 * @author Michaël Michaud
 */
public abstract class AbstractDatum extends IdentifiableComponent
        implements Datum {

    /**
     * The valid {@link Extent} of this Datum.
     */
    private Extent extent;
    /**
     * The description of this Datum origin.
     */
    private String origin;
    /**
     * The realization epoch of this Datum as a String.
     */
    private String epoch;

    /**
     * Creates a new Datum.
     *
     * @param identifier the identifier of this Datum
     * @param extent valid domain extent (extent definition depends on the kind
     * of Datum)
     * @param origin description of the origin or anchor point of this Datum.
     * @param epoch epoch of this Datum realization
     */
    protected AbstractDatum(Identifier identifier, Extent extent, String origin, String epoch) {
        super(identifier);
        this.extent = extent;
        this.origin = origin;
        this.epoch = epoch;
    }

    /**
     * Returns the valid extent of this Datum.
     */
    @Override
    public Extent getExtent() {
        return extent;
    }

    /**
     * Returns the description of this Datum origin.
     */
    @Override
    public String getOrigin() {
        return origin;
    }

    /**
     * Returns the realization epoch of this Datum as a String.
     */
    @Override
    public String getEpoch() {
        return epoch;
    }

    /**
     * Returns a String representation of this Datum.
     */
    @Override
    public String toString() {
        return getIdentifier().toString();
    }
}