Module org.apache.sis.referencing
Package org.apache.sis.referencing.datum

Class DefaultVerticalDatum

Object
FormattableObject
AbstractIdentifiedObject
AbstractDatum
DefaultVerticalDatum
All Implemented Interfaces:
Serializable, Formattable, Deprecable, Lenient­Comparable, Datum, Vertical­Datum, Identified­Object
public class DefaultVerticalDatum extends AbstractDatum implements VerticalDatum
Identifies a particular reference level surface used as a zero-height surface. There are several types of vertical datums, and each may place constraints on the coordinate system axis with which it is combined to create a vertical CRS.

Creating new vertical datum instances

New instances can be created either directly by specifying all information to a factory method (choices 3 and 4 below), or indirectly by specifying the identifier of an entry in a database (choices 1 and 2 below). Choice 1 in the following list is the easiest but most restrictive way to get a vertical datum. The other choices provide more freedom.
  1. Create a Vertical­Datum from one of the static convenience shortcuts listed in Common­CRS​.Vertical​.datum().
  2. Create a Vertical­Datum from an identifier in a database by invoking Datum­Authority­Factory​.create­Vertical­Datum(String).
  3. Create a Vertical­Datum by invoking the Datum­Factory​.create­Vertical­Datum(…) method (implemented for example by Geodetic­Object­Factory).
  4. Create a Default­Vertical­Datum by invoking the constructor.
Example: the following code gets a vertical datum for height above the geoid: 
VerticalDatum datum = CommonCRS.Vertical.GEOID.datum();

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.
Since:
0.4
See Also: