Interface VerticalDatum

All Superinterfaces:

Datum, Identified­Object

All Known Implementing Classes:

Default­Vertical­Datum, Default­Vertical­Datum.Dynamic

@UML(identifier="CD_VerticalDatum",
     specification=ISO_19111)
public interface VerticalDatum
extends Datum

A textual description and/or a set of parameters identifying a particular reference level surface used as a zero-height surface. The description includes its position with respect to the Earth for any of the height types recognized by this standard. There are several types of Vertical Datums, and each may place constraints on the Coordinate Axis with which it is combined to create a Vertical CRS.

Since:

1.0

Field Summary

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Modifier and Type	Field	Description
static final String	ANCHOR_POINT_KEY	Key for the "anchor­Point" property to be given to the datum factory create­Foo(…) methods.
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domain­Of­Validity" property to be given to the datum factory create­Foo(…) methods.
static final String	REALIZATION_EPOCH_KEY	Key for the "realization­Epoch" property to be given to the datum factory create­Foo(…) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the datum factory create­Foo(…) methods.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Modifier and Type	Field	Description
static final String	ALIAS_KEY	Key for the "alias" property to be given to the object factory create­Foo(…) methods.
static final String	IDENTIFIERS_KEY	Key for the "identifiers" property to be given to the object factory create­Foo(…) methods.
static final String	NAME_KEY	Key for the "name" property to be given to the object factory create­Foo(…) methods.
static final String	REMARKS_KEY	Key for the "remarks" property to be given to the object factory create­Foo(…) methods.

Method Summary

Modifier and Type	Method	Description
Vertical­Datum­Type	get­Vertical­Datum­Type()	The type of this vertical datum.

Methods inherited from interface Datum

get­Anchor­Point, get­Domain­Of­Validity, get­Realization­Epoch, get­Scope

Modifier and Type	Method	Description
International­String	get­Anchor­Point()	Description, possibly including coordinates, of the point or points used to anchor the datum to the Earth.
Extent	get­Domain­Of­Validity()	Area or region or timeframe in which this datum is valid.
Date	get­Realization­Epoch()	The time after which this datum definition is valid.
International­String	get­Scope()	Description of domain of usage, or limitations of usage, for which this datum object is valid.

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Modifier and Type	Method	Description
Collection<Generic­Name>	get­Alias()	An alternative name by which this object is identified.
Set<Reference­Identifier>	get­Identifiers()	An identifier which references elsewhere the object's defining information.
Reference­Identifier	get­Name()	The primary name by which this object is identified.
International­String	get­Remarks()	Comments on or information about this object, including data source information.
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

Method Details

getVerticalDatumType

@UML(identifier="vertDatumType",
     obligation=MANDATORY,
     specification=ISO_19111)
VerticalDatumType getVerticalDatumType()

The type of this vertical datum. Default is "geoidal".

Returns:

The type of this vertical datum.