Package org.geotools.referencing.cs

Class DefaultLinearCS

Object

Formattable

AbstractIdentifiedObject

AbstractCS

DefaultLinearCS

All Implemented Interfaces:

Serializable, CoordinateSystem, LinearCS, IdentifiedObject

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.1

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class Formattable

SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultLinearCS(String name, CoordinateSystemAxis axis)	Constructs a coordinate system from a name.
DefaultLinearCS(Map<String,?> properties, CoordinateSystemAxis axis)	Constructs a coordinate system from a set of properties.
DefaultLinearCS(LinearCS cs)	Constructs a new coordinate system with the same values than the specified one.

Method Summary

Modifier and Type	Method	Description
Measure	distance(double[] coord1, double[] coord2)	Computes the distance between two points.

Methods inherited from class AbstractCS

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

Methods inherited from class AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches

Methods inherited from class Formattable

cleanupThreadLocals, toString, toWKT, 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 wrap an arbitrary implementation into a Geotools 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.

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

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.