Class DefaultVerticalDatum.Dynamic

Object

FormattableObject

AbstractIdentifiedObject

AbstractDatum

DefaultVerticalDatum

Dynamic

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Datum, Vertical­Datum, Identified­Object

Enclosing class:

Default­Vertical­Datum

public static class DefaultVerticalDatum.Dynamic
extends DefaultVerticalDatum

A vertical reference frame in which some of the defining parameters have time dependency. The parameter values are valid at the time given by the frame reference epoch.

Upcoming API change: this class may implement a Dynamic­Reference­Frame interface from the GeoAPI standard after the next GeoAPI release. In the meantime, Dynamic­Reference­Frame is not a public API.

Since:

1.5

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class DefaultVerticalDatum

Default­Vertical­Datum.Dynamic

Field Summary

Fields inherited from class AbstractDatum

ANCHOR_DEFINITION_KEY, ANCHOR_EPOCH_KEY, CONVENTIONAL_RS_KEY, PUBLICATION_DATE_KEY

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Fields inherited from interface Datum

ANCHOR_POINT_KEY, DOMAIN_OF_VALIDITY_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
	Dynamic(Map<String,?> properties, Vertical­Datum­Type type, Temporal epoch)	Creates a dynamic reference frame from the given properties.
protected	Dynamic(Vertical­Datum datum)	Creates a new datum with the same values as the specified datum, which must be dynamic.

Method Summary

Modifier and Type	Method	Description
Temporal	get­Frame­Reference­Epoch()	Returns the epoch to which the coordinates of stations defining the dynamic reference frame are referenced.

Methods inherited from class DefaultVerticalDatum

cast­Or­Copy, format­To, get­Interface, get­Vertical­Datum­Type

Methods inherited from class AbstractDatum

cast­Or­Copy, get­Anchor­Definition, get­Anchor­Epoch, get­Anchor­Point, get­Conventional­RS, get­Domain­Of­Validity, get­Publication­Date, get­Realization­Epoch, get­Scope, is­Heuristic­Match­For­Name

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface Datum

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

Methods inherited from interface IdentifiedObject

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

Constructor Details

Dynamic

public Dynamic(Map<String,?> properties,
 VerticalDatumType type,
 Temporal epoch)

Creates a dynamic reference frame from the given properties. See super-class constructor for more information.

Parameters:

properties - the properties to be given to the identified object.

type - the type of this vertical datum.

epoch - the epoch to which the definition of the dynamic reference frame is referenced.

Dynamic

protected Dynamic(VerticalDatum datum)

Creates a new datum with the same values as the specified datum, which must be dynamic.

Parameters:

datum - the datum to copy.

Throws:

Class­Cast­Exception - if the given datum is not an instance of Dynamic­Reference­Frame.

See Also:

• Default­Vertical­Datum.cast­Or­Copy(Vertical­Datum)

Method Details

getFrameReferenceEpoch

public Temporal getFrameReferenceEpoch()

Returns the epoch to which the coordinates of stations defining the dynamic reference frame are referenced. The type of the returned object depends on the epoch accuracy and the calendar in use. It may be merely a Year.

Returns:

the epoch to which the definition of the dynamic reference frame is referenced.