org.cts.crs

Class VerticalCRS

java.lang.Object

org.cts.IdentifiableComponent

org.cts.crs.VerticalCRS

All Implemented Interfaces:

CoordinateReferenceSystem, Identifiable

public class VerticalCRS
extends IdentifiableComponent
implements CoordinateReferenceSystem

A vertical CoordinateReferenceSystem is a CoordinateReferenceSystem based on a VerticalDatum. It is used to indicate what is the reference for the vertical ordinate of a 3D point (ex. ellipsoid surface, world geoid, local geoid...).

Author:

Michaël Michaud, Jules Party

Nested Class Summary

Nested classes/interfaces inherited from interface org.cts.crs.CoordinateReferenceSystem

CoordinateReferenceSystem.Type

Field Summary

Fields

Modifier and Type	Field and Description
static CoordinateSystem	ALTITUDE_CS A 1D CoordinateSystem whose Axis contains the altitude.
static CoordinateSystem	HEIGHT_CS A 1D CoordinateSystem whose Axis contains the (ellipsoidal) height.

Fields inherited from interface org.cts.Identifiable

DEFAULT, LOCAL, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
VerticalCRS(Identifier identifier, VerticalDatum datum) Create a new VerticalCRS.
VerticalCRS(Identifier identifier, VerticalDatum datum, CoordinateSystem cs) Create a new VerticalCRS.

Method Summary

Modifier and Type	Method and Description
CoordinateSystem	getCoordinateSystem() Returns the CoordinateSystem used by this CoordinateReferenceSystem.
VerticalDatum	getDatum() Return the VerticalDatum.
Projection	getProjection() Returns the Projection to which this CoordinateReferenceSystem is refering.
CoordinateReferenceSystem.Type	getType() Returns this CoordinateReferenceSystem Type.
boolean	isValid(double[] coord) Return whether this coord is a valid coord in this CoordinateReferenceSystem.
String	toString() Return a String representation of this Datum.
String	toWKT() Returns a WKT representation of the vertical CRS.

Methods inherited from class org.cts.IdentifiableComponent

addAlias, addRemark, equals, getAliases, getAuthorityKey, getAuthorityName, getCode, getComponent, getIdentifier, getName, getRemarks, getShortName, hashCode, setIdentifier, setRemarks, setShortName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cts.Identifiable

addAlias, addRemark, getAliases, getAuthorityKey, getAuthorityName, getCode, getName, getRemarks, getShortName, setRemarks, setShortName

Field Detail

HEIGHT_CS

public static final CoordinateSystem HEIGHT_CS

A 1D CoordinateSystem whose Axis contains the (ellipsoidal) height. The units used by this axis is meter.

ALTITUDE_CS

public static CoordinateSystem ALTITUDE_CS

A 1D CoordinateSystem whose Axis contains the altitude. The units used by this axis is meter.

Constructor Detail

VerticalCRS

public VerticalCRS(Identifier identifier,
                   VerticalDatum datum,
                   CoordinateSystem cs)

Create a new VerticalCRS.

Parameters:

identifier - the identifier of the VerticalCRS

datum - the datum associated with the VerticalCRS

cs - the coordinate system associated with the VerticalCRS

VerticalCRS

public VerticalCRS(Identifier identifier,
                   VerticalDatum datum)

Create a new VerticalCRS.

Parameters:

identifier - the identifier of the VerticalCRS

datum - the datum associated with the VerticalCRS

Method Detail

getProjection

public Projection getProjection()

Description copied from interface: CoordinateReferenceSystem

Returns the Projection to which this CoordinateReferenceSystem is refering. It returns null if no projection is defined for this CRS.

Specified by:

getProjection in interface CoordinateReferenceSystem

Returns:

See Also:

CoordinateReferenceSystem.getProjection()

getType

public CoordinateReferenceSystem.Type getType()

Description copied from interface: CoordinateReferenceSystem

Returns this CoordinateReferenceSystem Type.

Specified by:

getType in interface CoordinateReferenceSystem

Returns:

See Also:

CoordinateReferenceSystem.getType()

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

Description copied from interface: CoordinateReferenceSystem

Returns the CoordinateSystem used by this CoordinateReferenceSystem.

Specified by:

getCoordinateSystem in interface CoordinateReferenceSystem

Returns:

See Also:

CoordinateReferenceSystem.getCoordinateSystem()

getDatum

public VerticalDatum getDatum()

Return the VerticalDatum.

Specified by:

getDatum in interface CoordinateReferenceSystem

Returns:

isValid

public boolean isValid(double[] coord)

Return whether this coord is a valid coord in this CoordinateReferenceSystem.

Parameters:

coord - standard coordinate for this CoordinateReferenceSystem datums (ex. decimal degrees for geographic datums and meters for vertical datums).

Returns:

toWKT

public String toWKT()

Returns a WKT representation of the vertical CRS.

Specified by:

toWKT in interface CoordinateReferenceSystem

Returns:

toString

public String toString()

Return a String representation of this Datum.

Overrides:

toString in class IdentifiableComponent

Returns: