Value uniquely identifying an object within a namespace. More...

#include <metadata.hpp>

Inheritance diagram for osgeo::proj::metadata::Identifier:

Collaboration diagram for osgeo::proj::metadata::Identifier:

Public Member Functions
const util::optional< Citation > &	authority () PROJ_CONST_DECL
	Return a citation for the organization responsible for definition and maintenance of the code. More...

const std::string &	code () PROJ_CONST_DECL
	Return the alphanumeric value identifying an instance in the codespace. More...

const util::optional< std::string > &	codeSpace () PROJ_CONST_DECL
	Return the organization responsible for definition and maintenance of the code. More...

const util::optional< std::string > &	version () PROJ_CONST_DECL
	Return the version identifier for the namespace. More...

const util::optional< std::string > &	description () PROJ_CONST_DECL
	Return the natural language description of the meaning of the code value. More...

const util::optional< std::string > &	uri () PROJ_CONST_DECL
	Return the URI of the identifier. More...

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

Static Public Member Functions
static IdentifierNNPtr	create (const std::string &codeIn=std::string(), const util::PropertyMap &properties=util::PropertyMap())
	Instanciate a Identifier. More...

static bool	isEquivalentName (const char *a, const std::string &b)
	Returns whether two names are considered equivalent. More...

static bool	isEquivalentName (const std::string &a, const std::string &b)
	Returns whether two names are considered equivalent. More...

Static Public Attributes
static const std::string	AUTHORITY_KEY
	Key to set the authority citation of a metadata::Identifier. More...

static const std::string	CODE_KEY
	Key to set the code of a metadata::Identifier. More...

static const std::string	CODESPACE_KEY
	Key to set the organization responsible for definition and maintenance of the code of a metadata::Identifier. More...

static const std::string	VERSION_KEY
	Key to set the version identifier for the namespace of a metadata::Identifier. More...

static const std::string	DESCRIPTION_KEY
	Key to set the natural language description of the meaning of the code value of a metadata::Identifier. More...

static const std::string	URI_KEY
	Key to set the URI of a metadata::Identifier. More...

static const std::string	EPSG
	EPSG codespace.

static const std::string	OGC
	OGC codespace.

Detailed Description

Value uniquely identifying an object within a namespace.

Remarks: Implements Identifier as described in ISO 19111:2018 but which originates from ISO 19115 (Metadata)

Member Function Documentation

const optional< Citation > & osgeo::proj::metadata::Identifier::authority ( )

Return a citation for the organization responsible for definition and maintenance of the code.

Returns: the citation for the authority, or empty.

const std::string & osgeo::proj::metadata::Identifier::code ( )

Return the alphanumeric value identifying an instance in the codespace.

e.g. "4326" (for EPSG:4326 WGS 84 GeographicCRS)

Returns: the code.

const optional< std::string > & osgeo::proj::metadata::Identifier::codeSpace ( )

Return the organization responsible for definition and maintenance of the code.

e.g "EPSG"

Returns: the authority codespace, or empty.

IdentifierNNPtr osgeo::proj::metadata::Identifier::create	(	const std::string &	codeIn = `std::string()`,
		const util::PropertyMap &	properties = `util::PropertyMap()`
	)

static

Instanciate a Identifier.

Parameters

codeIn	Alphanumeric value identifying an instance in the codespace
properties	See General properties. Generally, the Identifier::CODESPACE_KEY should be set.

Returns: a new Identifier.

const optional< std::string > & osgeo::proj::metadata::Identifier::description ( )

Return the natural language description of the meaning of the code value.

Returns: the description or empty.

bool osgeo::proj::metadata::Identifier::isEquivalentName	(	const char *	a,
		const std::string &	b
	)

static

Returns whether two names are considered equivalent.

Two names are equivalent by removing any space, underscore, dash, slash, { or } character from them, and comparing ina case insensitive way.

bool osgeo::proj::metadata::Identifier::isEquivalentName	(	const std::string &	a,
		const std::string &	b
	)

static

Returns whether two names are considered equivalent.

Two names are equivalent by removing any space, underscore, dash, slash, { or } character from them, and comparing ina case insensitive way.

const optional< std::string > & osgeo::proj::metadata::Identifier::uri ( )

Return the URI of the identifier.

Returns: the URI or empty.

const optional< std::string > & osgeo::proj::metadata::Identifier::version ( )

Return the version identifier for the namespace.

When appropriate, the edition is identified by the effective date, coded using ISO 8601 date format.

Returns: the version or empty.

Member Data Documentation

const std::string osgeo::proj::Identifier::AUTHORITY_KEY

static

Key to set the authority citation of a metadata::Identifier.

The value is to be provided as a string or a metadata::Citation.

const std::string osgeo::proj::Identifier::CODE_KEY

static

Key to set the code of a metadata::Identifier.

The value is to be provided as a integer or a string.

const std::string osgeo::proj::Identifier::CODESPACE_KEY

static

Key to set the organization responsible for definition and maintenance of the code of a metadata::Identifier.

The value is to be provided as a string.

const std::string osgeo::proj::Identifier::DESCRIPTION_KEY

static

Key to set the natural language description of the meaning of the code value of a metadata::Identifier.

The value is to be provided as a string.

const std::string osgeo::proj::Identifier::URI_KEY

static

Key to set the URI of a metadata::Identifier.

The value is to be provided as a string.

const std::string osgeo::proj::Identifier::VERSION_KEY

static

Key to set the version identifier for the namespace of a metadata::Identifier.

The value is to be provided as a string.

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation