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

Modifier and Type	Class	Description
static class	Default­Vertical­Datum.Dynamic	A vertical reference frame in which some of the defining parameters have time dependency.

Field Summary

Fields inherited from class AbstractDatum

ANCHOR_DEFINITION_KEY, ANCHOR_EPOCH_KEY, CONVENTIONAL_RS_KEY, PUBLICATION_DATE_KEY

Modifier and Type	Field	Description
static final String	ANCHOR_DEFINITION_KEY	Key for the "anchor­Definition" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.
static final String	ANCHOR_EPOCH_KEY	Key for the "anchor­Epoch" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.
static final String	CONVENTIONAL_RS_KEY	Key for the "conventional­RS" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.
static final String	PUBLICATION_DATE_KEY	Key for the "publication­Date" property to be given to the Datum­Factory.create­Foo(Map, ...) methods.

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY	Optional key which can be given to the constructor for specifying the object is deprecated.
static final String	DOMAINS_KEY	Key for the "domains" property to be given to the Object­Factory.create­Foo(Map, ...) methods.
static final String	LOCALE_KEY	Optional key which can be given to the constructor for specifying the locale to use for producing error messages.

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.

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­Standard­Type, get­Vertical­Datum­Type

Modifier and Type	Method	Description
static Default­Vertical­Datum	cast­Or­Copy(Vertical­Datum object)	Returns a SIS datum implementation with the same values as the given arbitrary implementation.
protected String	format­To(Formatter formatter)	Formats this datum as a Well Known Text Vertical­Datum[…] element.
Type	get­Standard­Type()	Returns the GeoAPI interface that defines the contract of this implementation class.
Vertical­Datum­Type	get­Vertical­Datum­Type()	Returns the type of this vertical datum.

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

Modifier and Type	Method	Description
static Abstract­Datum	cast­Or­Copy(Datum object)	Returns a SIS datum implementation with the values of the given arbitrary implementation.
Optional<International­String>	get­Anchor­Definition()	Returns a description of the relationship used to anchor the coordinate system to the Earth or alternate object.
Optional<Temporal>	get­Anchor­Epoch()	Returns the epoch at which a static datum matches a dynamic datum from which it has been derived.
International­String	get­Anchor­Point()	Deprecated. Renamed Abstract­Datum.get­Anchor­Definition() as of ISO 19111:2019.
Optional<Identified­Object>	get­Conventional­RS()	Returns the name, identifier, alias and remarks for the reference system realized by this reference frame.
Extent	get­Domain­Of­Validity()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
Optional<Temporal>	get­Publication­Date()	Returns the date on which the datum definition was published.
Date	get­Realization­Epoch()	Deprecated. Since ISO 19111:2019, replaced by Abstract­Datum.get­Anchor­Epoch().
International­String	get­Scope()	Deprecated. Replaced by Abstract­Identified­Object.get­Domains() as of ISO 19111:2019.
boolean	is­Heuristic­Match­For­Name(String name)	Returns true if either the primary name or at least one alias matches the given string according heuristic rules.

Methods inherited from class AbstractIdentifiedObject

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

Modifier and Type	Method	Description
static Abstract­Identified­Object	cast­Or­Copy(Identified­Object object)	Returns a SIS identified object implementation with the values of the given arbitrary implementation.
final boolean	equals(Object object)	Compares the specified object with this object for equality.
void	format­To(Formatter formatter, int flags, int width, int precision)	Formats the name or identifier of this object using the provider formatter.
Collection<Generic­Name>	get­Alias()	Returns alternative names by which this object is identified.
Optional<International­String>	get­Description()	Returns a narrative explanation of the role of this object.
Collection<Default­Object­Domain>	get­Domains()	Returns the usage of this CRS-related object.
Set<Reference­Identifier>	get­Identifiers()	Returns identifiers which references elsewhere the object's defining information.
final Class<? extends Identified­Object>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Identified­Object.get­Standard­Type() for integration with Lenient­Comparable.
Reference­Identifier	get­Name()	Returns the primary name by which this object is identified.
International­String	get­Remarks()	Returns comments on or information about this object, including data source information.
final int	hash­Code()	Returns a hash value for this identified object.
boolean	is­Deprecated()	Returns true if this object is deprecated.

Methods inherited from class FormattableObject

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

Modifier and Type	Method	Description
void	print()	Prints a string representation of this object to the standard output stream.
String	to­String()	Returns a Well Known Text (WKT) or an alternative text representation for this object.
String	to­String(Convention convention)	Returns a Well Known Text (WKT) for this object using the specified convention.
String	to­WKT()	Returns a strictly compliant Well Known Text (WKT) using the default convention, symbols and indentation.

Methods inherited from class Object

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

Methods inherited from interface IdentifiedObject

to­WKT

Modifier and Type	Method	Description
String	to­WKT()	Returns a Well Known Text (WKT) for this object.

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.