org.geotoolkit.referencing.cs
Class DefaultLinearCS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractCS
              DefaultLinearCS

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, CoordinateSystem, LinearCS, IdentifiedObject

@Immutable
public class DefaultLinearCS
extends AbstractCS
implements LinearCS

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 LinearCS shall have one axis.

Used with CRS type(s)

Engineering

Since:

2.0

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultLinearCS(LinearCS cs)
Constructs a new coordinate system with the same values than the specified one.

DefaultLinearCS(Map<String,?> properties, CoordinateSystemAxis axis)
Constructs a coordinate system from a set of properties.

DefaultLinearCS(String name, CoordinateSystemAxis axis)
Constructs a coordinate system from a name.

Method Summary

static DefaultLinearCS	castOrCopy(LinearCS object) Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation.
Measure	distance(double[] coord1, double[] coord2) Computes the distance between two points.
static DefaultLinearCS	wrap(LinearCS object) Deprecated. Renamed castOrCopy.

Methods inherited from class AbstractCS

computeHashCode, equals, formatWKT, getAxis, getDimension, isCompatibleDirection, isCompatibleUnit, standard, swapAndScaleAxis

Methods inherited from class AbstractIdentifiedObject

equals, getAlias, getIdentifier, getIdentifiers, getName, getName, getRemarks, hashCode, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CoordinateSystem

getAxis, getDimension

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Constructor Detail

DefaultLinearCS

public DefaultLinearCS(LinearCS cs)

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.

Parameters:

cs - The coordinate system to copy.

Since:

2.2

DefaultLinearCS

public DefaultLinearCS(String name,
                       CoordinateSystemAxis axis)

Constructs a coordinate system from a name.

Parameters:

name - The coordinate system name.

axis - The axis.

DefaultLinearCS

public DefaultLinearCS(Map<String,?> properties,
                       CoordinateSystemAxis axis)

Constructs a coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

axis - The axis.

Method Detail

castOrCopy

public static DefaultLinearCS castOrCopy(LinearCS object)

Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns 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.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

wrap

@Deprecated
public static DefaultLinearCS wrap(LinearCS object)

Deprecated. Renamed castOrCopy.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

The given object as a Geotk implementation.

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws MismatchedDimensionException

Computes the distance between two points.

Overrides:

distance in class AbstractCS

Parameters:

coord1 - Coordinates of the first point.

coord2 - Coordinates of the second point.

Returns:

The distance between coord1 and coord2.

Throws:

MismatchedDimensionException - if a coordinate doesn't have the expected dimension.