org.geotoolkit.referencing.cs.DefaultLinearCS Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotk-referencing Show documentation
Show all versions of geotk-referencing Show documentation
Implementations of Coordinate Reference Systems (CRS),
conversion and transformation services derived from ISO 19111.
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2004-2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2011, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library 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
* Lesser General Public License for more details.
*
* This package contains documentation from OpenGIS specifications.
* OpenGIS consortium's work is fully acknowledged here.
*/
package org.geotoolkit.referencing.cs;
import java.util.Map;
import net.jcip.annotations.Immutable;
import org.opengis.referencing.cs.LinearCS;
import org.opengis.referencing.cs.CoordinateSystemAxis;
import org.opengis.geometry.MismatchedDimensionException;
import org.geotoolkit.measure.Measure;
/**
* A one-dimensional coordinate system that consists of the points that lie on the single axis
* described. The associated ordinate is the distance from the specified origin to the point
* along the axis. Example: usage of the line feature representing a road to describe points
* on or along that road. A {@code LinearCS} shall have one
* {@linkplain #getAxis axis}.
*
*
* Used with CRS type(s)
*
* {@link org.geotoolkit.referencing.crs.DefaultEngineeringCRS Engineering}
*
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @version 3.19
*
* @since 2.0
* @module
*/
@Immutable
public class DefaultLinearCS extends AbstractCS implements LinearCS {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = -6890723478287625763L;
/**
* Constructs a new object in which every attributes are set to a default value.
* This is not a valid object. This constructor is strictly
* reserved to JAXB, which will assign values to the fields using reflexion.
*/
private DefaultLinearCS() {
this(org.geotoolkit.internal.referencing.NilReferencingObject.INSTANCE);
}
/**
* Constructs a new coordinate system with the same values than the specified one.
* This copy constructor provides a way to convert an arbitrary implementation into a
* Geotk one or a user-defined one (as a subclass), usually in order to leverage
* some implementation-specific API. This constructor performs a shallow copy,
* i.e. the properties are not cloned.
*
* @param cs The coordinate system to copy.
*
* @since 2.2
*/
public DefaultLinearCS(final LinearCS cs) {
super(cs);
}
/**
* Constructs a coordinate system from a name.
*
* @param name The coordinate system name.
* @param axis The axis.
*/
public DefaultLinearCS(final String name, final CoordinateSystemAxis axis) {
super(name, axis);
}
/**
* Constructs a coordinate system from a set of properties.
* The properties map is given unchanged to the
* {@linkplain AbstractCS#AbstractCS(Map,CoordinateSystemAxis[]) super-class constructor}.
*
* @param properties Set of properties. Should contains at least {@code "name"}.
* @param axis The axis.
*/
public DefaultLinearCS(final Map properties, final CoordinateSystemAxis axis) {
super(properties, axis);
}
/**
* Returns a Geotk coordinate system implementation with the same values than the given arbitrary
* implementation. If the given object is {@code null}, then this method returns {@code null}.
* Otherwise if the given object is already a Geotk implementation, then the given object is
* returned unchanged. Otherwise a new Geotk implementation is created and initialized to the
* attribute values of the given object.
*
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return A Geotk implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*
* @since 3.18
*/
public static DefaultLinearCS castOrCopy(final LinearCS object) {
return (object == null) || (object instanceof DefaultLinearCS)
? (DefaultLinearCS) object : new DefaultLinearCS(object);
}
/**
* @deprecated Renamed {@link #castOrCopy castOrCopy}.
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return The given object as a Geotk implementation.
*/
@Deprecated
public static DefaultLinearCS wrap(final LinearCS object) {
return castOrCopy(object);
}
/**
* Computes the distance between two points.
*
* @param coord1 Coordinates of the first point.
* @param coord2 Coordinates of the second point.
* @return The distance between {@code coord1} and {@code coord2}.
* @throws MismatchedDimensionException if a coordinate doesn't have the expected dimension.
*/
@Override
public Measure distance(final double[] coord1, final double[] coord2)
throws MismatchedDimensionException
{
ensureDimensionMatch("coord1", coord1);
ensureDimensionMatch("coord2", coord2);
return new Measure(Math.abs(coord1[0] - coord2[0]), getDistanceUnit());
}
}