The definition of the relationship of a temporal coordinate system to an object. The object is normally time on the Earth. More...

#include <datum.hpp>

Inheritance diagram for osgeo::proj::datum::TemporalDatum:

[legend]

Collaboration diagram for osgeo::proj::datum::TemporalDatum:

[legend]

Public Member Functions
const common::DateTime &	temporalOrigin () const
	Return the date and time to which temporal coordinates are referenced, expressed in conformance with ISO 8601. More...

const std::string &	calendar () const
	Return the calendar to which the temporal origin is referenced. More...

bool	isEquivalentTo (const util::IComparable *other, util::IComparable::Criterion criterion=util::IComparable::Criterion::STRICT) const override
	Returns whether an object is equivalent to another one. More...

Public Member Functions inherited from osgeo::proj::datum::Datum
const util::optional< std::string > &	anchorDefinition () const
	Return the anchor definition. More...

const util::optional< common::DateTime > &	publicationDate () const
	Return the date on which the datum definition was published. More...

const common::IdentifiedObjectPtr &	conventionalRS () const
	Return the conventional reference system. More...

Public Member Functions inherited from osgeo::proj::common::ObjectUsage
const std::vector< ObjectDomainNNPtr > &	domains () PROJ_CONST_DECL
	Return the domains of the object.

Public Member Functions inherited from osgeo::proj::common::IdentifiedObject
const metadata::IdentifierNNPtr &	name () PROJ_CONST_DECL
	Return the name of the object. More...

const std::string &	nameStr () PROJ_CONST_DECL
	Return the name of the object. More...

const std::vector< metadata::IdentifierNNPtr > &	identifiers () PROJ_CONST_DECL
	Return the identifier(s) of the object. More...

const std::vector< util::GenericNameNNPtr > &	aliases () PROJ_CONST_DECL
	Return the alias(es) of the object.

const std::string &	remarks () PROJ_CONST_DECL
	Return the remarks.

bool	isDeprecated () PROJ_CONST_DECL
	Return whether the object is deprecated. More...

std::string	alias () PROJ_CONST_DECL
	Return the (first) alias of the object as a string. More...

int	getEPSGCode () PROJ_CONST_DECL
	Return the EPSG code. More...

bool	isEPSG (int code) PROJ_CONST_DECL
	Return whether the object has a identifiers() in the EPSG code space.

Public Member Functions inherited from osgeo::proj::io::IWKTExportable
std::string	exportToWKT (WKTFormatter *formatter) const

Static Public Member Functions
static TemporalDatumNNPtr	create (const util::PropertyMap &properties, const common::DateTime &temporalOriginIn, const std::string &calendarIn)
	Instanciate a TemporalDatum. More...

Static Public Member Functions inherited from osgeo::proj::common::IdentifiedObject
static IdentifiedObjectNNPtr	create (const util::PropertyMap &properties)
	Instanciate a new IdentifiedObject. More...

Static Public Attributes
static const std::string	CALENDAR_PROLEPTIC_GREGORIAN
	The proleptic Gregorian calendar.

Static Public Attributes inherited from osgeo::proj::common::ObjectUsage
static const std::string	SCOPE_KEY
	Key to set the scope of a common::ObjectUsage. More...

static const std::string	DOMAIN_OF_VALIDITY_KEY
	Key to set the domain of validity of a common::ObjectUsage. More...

static const std::string	OBJECT_DOMAIN_KEY
	Key to set the object domain(s) of a common::ObjectUsage. More...

Static Public Attributes inherited from osgeo::proj::common::IdentifiedObject
static const std::string	NAME_KEY
	Key to set the name of a common::IdentifiedObject. More...

static const std::string	IDENTIFIERS_KEY
	Key to set the identifier(s) of a common::IdentifiedObject. More...

static const std::string	ALIAS_KEY
	Key to set the alias(es) of a common::IdentifiedObject. More...

static const std::string	REMARKS_KEY
	Key to set the remarks of a common::IdentifiedObject. More...

static const std::string	DEPRECATED_KEY
	Key to set the deprecation flag of a common::IdentifiedObject. More...

Additional Inherited Members
Public Types inherited from osgeo::proj::util::IComparable
enum	Criterion { Criterion::STRICT, Criterion::EQUIVALENT }
	Comparison criterion. More...

Detailed Description

The definition of the relationship of a temporal coordinate system to an object. The object is normally time on the Earth.

Remarks: Implements TemporalDatum from ISO 19111:2018

Member Function Documentation

const std::string & osgeo::proj::datum::TemporalDatum::calendar ( ) const

Return the calendar to which the temporal origin is referenced.

Default value: TemporalDatum::CALENDAR_PROLEPTIC_GREGORIAN.

Returns: the calendar.

TemporalDatumNNPtr osgeo::proj::datum::TemporalDatum::create	(	const util::PropertyMap &	properties,
		const common::DateTime &	temporalOriginIn,
		const std::string &	calendarIn
	)

static

Instanciate a TemporalDatum.

Parameters

properties	See General properties. At minimum the name should be defined.
temporalOriginIn	the temporal origin into which temporal coordinates are referenced.
calendarIn	the calendar (generally TemporalDatum::CALENDAR_PROLEPTIC_GREGORIAN)

Returns: new TemporalDatum.

bool osgeo::proj::datum::TemporalDatum::isEquivalentTo	(	const util::IComparable *	other,
		util::IComparable::Criterion	criterion = `util::IComparable::Criterion::STRICT`
	)		const

overridevirtual

Returns whether an object is equivalent to another one.

Parameters

other	other object to compare to
criterion	comparaison criterion.

Returns: true if objects are equivalent.

Reimplemented from osgeo::proj::common::ObjectUsage.

const common::DateTime & osgeo::proj::datum::TemporalDatum::temporalOrigin ( ) const

Return the date and time to which temporal coordinates are referenced, expressed in conformance with ISO 8601.

Returns: the temporal origin.

The documentation for this class was generated from the following files:

include/proj/datum.hpp
src/datum.cpp
src/static.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation