The method (algorithm or procedure) used to perform the coordinate operation. More...

#include <coordinateoperation.hpp>

Inheritance diagram for osgeo::proj::operation::OperationMethod:

[legend]

Collaboration diagram for osgeo::proj::operation::OperationMethod:

[legend]

Public Member Functions
const util::optional< std::string > &	formula () PROJ_CONST_DECL
	Return the formula(s) or procedure used by this coordinate operation method. More...

const util::optional< metadata::Citation > &	formulaCitation () PROJ_CONST_DECL
	Return a reference to a publication giving the formula(s) or procedure used by the coordinate operation method. More...

const std::vector< GeneralOperationParameterNNPtr > &	parameters () PROJ_CONST_DECL
	Return the parameters of this operation method. 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::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 OperationMethodNNPtr	create (const util::PropertyMap &properties, const std::vector< GeneralOperationParameterNNPtr > &parameters)
	Instantiate a operation method from a vector of GeneralOperationParameter. More...

static OperationMethodNNPtr	create (const util::PropertyMap &properties, const std::vector< OperationParameterNNPtr > &parameters)
	Instantiate a operation method from a vector of OperationParameter. More...

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

Additional Inherited Members
Public Types inherited from osgeo::proj::util::IComparable
enum	Criterion { Criterion::STRICT, Criterion::EQUIVALENT }
	Comparison criterion. 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...

Detailed Description

The method (algorithm or procedure) used to perform the coordinate operation.

For a projection method, this contains the name of the projection method and the name of the projection parameters.

Remarks: Implements OperationMethod from ISO 19111:2018

Member Function Documentation

OperationMethodNNPtr osgeo::proj::operation::OperationMethod::create	(	const util::PropertyMap &	properties,
		const std::vector< GeneralOperationParameterNNPtr > &	parameters
	)

static

Instantiate a operation method from a vector of GeneralOperationParameter.

Parameters

properties	See General properties. At minimum the name should be defined.
parameters	Vector of GeneralOperationParameterNNPtr.

Returns: a new OperationMethod.

OperationMethodNNPtr osgeo::proj::operation::OperationMethod::create	(	const util::PropertyMap &	properties,
		const std::vector< OperationParameterNNPtr > &	parameters
	)

static

Instantiate a operation method from a vector of OperationParameter.

Parameters

properties	See General properties. At minimum the name should be defined.
parameters	Vector of OperationParameterNNPtr.

Returns: a new OperationMethod.

const util::optional< std::string > & osgeo::proj::operation::OperationMethod::formula ( )

Return the formula(s) or procedure used by this coordinate operation method.

This may be a reference to a publication (in which case use formulaCitation()).

Note that the operation method may not be analytic, in which case this attribute references or contains the procedure, not an analytic formula.

Returns: the formula, or empty.

const util::optional< metadata::Citation > & osgeo::proj::operation::OperationMethod::formulaCitation ( )

Return a reference to a publication giving the formula(s) or procedure used by the coordinate operation method.

Returns: the formula citation, or empty.

bool osgeo::proj::operation::OperationMethod::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.

Implements osgeo::proj::util::IComparable.

const std::vector< GeneralOperationParameterNNPtr > & osgeo::proj::operation::OperationMethod::parameters ( )

Return the parameters of this operation method.

Returns: the parameters.

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

include/proj/coordinateoperation.hpp
src/coordinateoperation.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation