Represents a Projected Coordinate System (PCS). More...

#include <ProjectedCoordinateSystemInterface.h>

Public Member Functions
virtual FLE_DLL	~ProjectedCoordinateSystemInterface ()=default

virtual FLE_DLL bool	isValid () const =0

virtual FLE_DLL Result	importFromWTK (ConstStringBuffer wtk)=0

virtual FLE_DLL Result	loadFromWellKnownText (ConstStringBuffer wtk)=0
	Equivalent to importFromWTK.

virtual FLE_DLL Size	getWellKnownTextLength () const =0

virtual FLE_DLL Result	getWellKnownText (StringBuffer outWtk) const =0

virtual FLE_DLL Size	getNameLength () const =0

virtual FLE_DLL Result	getName (StringBuffer outName) const =0

virtual FLE_DLL Size	getUnitNameLength () const =0
	Retrieves the length of this PCS unit.

virtual FLE_DLL Result	getUnitName (StringBuffer outUnitName) const =0

virtual FLE_DLL Size	getProjectionNameLength () const =0
	Retrieves the length of this PCS projection name.

virtual FLE_DLL Result	getProjectionName (StringBuffer outProjectionName) const =0

virtual FLE_DLL void	getProjectionParameters (double &outScaleFactor, double &outCentralMeridian, double &outLatitudeOfOrigin, double &outFalseEasting, double &outFalseNorthing) const =0
	Retrieves information about this PCS projection method parameters.

virtual FLE_DLL Size	getSpheroidNameLength () const =0
	Retrieves the length of this PCS spheroid name.

virtual FLE_DLL Result	getSpheroidName (StringBuffer outSpheroidName) const =0

virtual FLE_DLL void	getSpheroidParameters (double &outInverseFlattening, double &outSemiMajorAxis) const =0

virtual FLE_DLL Size	getPrimeMeridianNameLength () const =0

virtual FLE_DLL Result	getPrimeMeridianName (StringBuffer outPrimeMeridianName) const =0

virtual FLE_DLL Size	getGeodeticDatumNameLength () const =0

virtual FLE_DLL Result	getGeodeticDatumName (StringBuffer outGeodeticDatumName) const =0

virtual FLE_DLL Size	getEPSGCodeLength () const =0

virtual FLE_DLL Result	getEPSGCode (StringBuffer outId) const =0

virtual FLE_DLL Result	convertToGS (Point3 &inOutCoordinates) const =0

virtual FLE_DLL Result	convertFromGS (Point3 &inOutCoordinates) const =0

Detailed Description

Represents a Projected Coordinate System (PCS).

To obtain a valid PCS, the instance must be initialized either with one of the import functions (e.g. ProjectedCoordinateSystemInterface::importFromWTK) or via one of ProjectedCoordinateSystemDB lookup methods (e.g. ProjectedCoordinateSystemDB::searchByEPSG)

Constructor & Destructor Documentation

◆ ~ProjectedCoordinateSystemInterface()

virtual FLE_DLL FlowEngine::ProjectedCoordinateSystemInterface::~ProjectedCoordinateSystemInterface ( )

virtualdefault

Member Function Documentation

◆ convertFromGS()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::convertFromGS ( Point3 & inOutCoordinates ) const

pure virtual

Converts the supplied coordinates from geographic coordinates (lat, lon) to this PCS coordinates.

Parameters

[in,out] inOutCoordinates the 3d coordinates to convert.

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::GenericError – if the function failed for any reason.

◆ convertToGS()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::convertToGS ( Point3 & inOutCoordinates ) const

pure virtual

Converts the supplied coordinates from this PCS to geographic coordinates (lat, lon)

Parameters

[in,out] inOutCoordinates the 3d coordinates to convert.

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::GenericError – if the function failed for any reason.

◆ getEPSGCode()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getEPSGCode ( StringBuffer outId ) const

pure virtual

Retrieves the European Petroleum Survey Group (EPSG) code of this Projected Coordinate System.

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outCode is not a valid string buffer.
Result::BufferTooSmall – if outCode is not big enough to receive the full code. See getEPSGCodeLength.
Result::GenericError – if the function failed for any other reason.

◆ getEPSGCodeLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getEPSGCodeLength ( ) const

pure virtual

Returns: the European Petroleum Survey Group (EPSG) code length of this Projected Coordinate System. The code is usually a 4-5 digits string

◆ getGeodeticDatumName()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getGeodeticDatumName ( StringBuffer outGeodeticDatumName ) const

pure virtual

Returns: the name of this PCS geodetic datum.

Parameters

[in,out] outGeodeticDatumName a string buffer that will receive the name of this PCS. the buffer must be big at least getGeodeticDatumNameLength().

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outGeodeticDatumName is not a valid string buffer.
Result::BufferTooSmall – if outGeodeticDatumName is not big enough to receive the full code. See getGeodeticDatumNameLength.
Result::GenericError – if the function failed for any other reason.

◆ getGeodeticDatumNameLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getGeodeticDatumNameLength ( ) const

pure virtual

Returns: the length of this PCS geodetic datum name.

◆ getName()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getName ( StringBuffer outName ) const

pure virtual

Get the name of this PCS.

Parameters

[in,out] outName a string buffer that will receive the name of this PCS. the buffer must be big at least getNameLength().

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outName is not a valid string buffer.
Result::BufferTooSmall – if outName is not big enough to receive the full code. See getNameLength.
Result::GenericError – if the function failed for any other reason.

◆ getNameLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getNameLength ( ) const

pure virtual

Returns: the length of this PCS name.

◆ getPrimeMeridianName()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getPrimeMeridianName ( StringBuffer outPrimeMeridianName ) const

pure virtual

Returns: the name of this PCS prime meridian.

Parameters

[in,out] outPrimeMeridianName a string buffer that will receive the name of this PCS. the buffer must be big at least getPrimeMeridianNameLength().

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outPrimeMeridianName is not a valid string buffer.
Result::BufferTooSmall – if outPrimeMeridianName is not big enough to receive the full code. See getPrimeMeridianNameLength.
Result::GenericError – if the function failed for any other reason.

◆ getPrimeMeridianNameLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getPrimeMeridianNameLength ( ) const

pure virtual

Returns: the length of this PCS prime meridian name.

◆ getProjectionName()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getProjectionName ( StringBuffer outProjectionName ) const

pure virtual

Retrieves the name of this PCS spheroid.

Parameters

[in,out] outProjectionName a string buffer that will receive the name of this PCS projection. the buffer must be big at least getProjectionNameLength().

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outProjectionName is not a valid string buffer.
Result::BufferTooSmall – if outProjectionName is not big enough to receive the full code. See getProjectionNameLength.
Result::GenericError – if the function failed for any other reason.

◆ getProjectionNameLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getProjectionNameLength ( ) const

pure virtual

Retrieves the length of this PCS projection name.

◆ getProjectionParameters()

virtual FLE_DLL void FlowEngine::ProjectedCoordinateSystemInterface::getProjectionParameters	(	double &	outScaleFactor,
		double &	outCentralMeridian,
		double &	outLatitudeOfOrigin,
		double &	outFalseEasting,
		double &	outFalseNorthing
	)		const

pure virtual

Retrieves information about this PCS projection method parameters.

◆ getSpheroidName()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getSpheroidName ( StringBuffer outSpheroidName ) const

pure virtual

Retrieves the name of this PCS spheroid.

Parameters

[in,out] outSpheroidName a string buffer that will receive the name of this PCS. the buffer must be big at least getSpheroidNameLength().

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outSpheroidName is not a valid string buffer.
Result::BufferTooSmall – if outSpheroidName is not big enough to receive the full code. See getSpheroidNameLength.
Result::GenericError – if the function failed for any other reason.

◆ getSpheroidNameLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getSpheroidNameLength ( ) const

pure virtual

Retrieves the length of this PCS spheroid name.

◆ getSpheroidParameters()

virtual FLE_DLL void FlowEngine::ProjectedCoordinateSystemInterface::getSpheroidParameters	(	double &	outInverseFlattening,
		double &	outSemiMajorAxis
	)		const

pure virtual

Retrieves information about this PCS spheroid parameters.

Precondition: This must be a valid PCS, i.e. isValid() must be true;

◆ getUnitName()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getUnitName ( StringBuffer outUnitName ) const

pure virtual

Retrieves the name of this PCS unit.

Parameters

[in,out] outUnitName a string buffer that will receive the name of this PCS projection. the buffer must be big at least getUnitNameLength().

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::PreconditionNotMet – if this is not a valid PCS.
Result::InvalidArgument – if outUnitName is not a valid string buffer.
Result::BufferTooSmall – if outUnitName is not big enough to receive the full code. See getUnitNameLength.
Result::GenericError – if the function failed for any other reason.

◆ getUnitNameLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getUnitNameLength ( ) const

pure virtual

Retrieves the length of this PCS unit.

◆ getWellKnownText()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::getWellKnownText ( StringBuffer outWtk ) const

pure virtual

Returns this PCS in a Well Known Text format (WTK) string.

Parameters

[out] outWtk a string buffer that will receive the WTK string. Must be at least getWellKnownTextLength() long.

Returns

One of the following result codes:

Result::Success – if the function succedeed and outWtk contains the WTK format of this PCS.
Result::PreconditionNotMet – if this is not a valid PCS. See isValid().
Result::InvalidArgument – if outWtk is not a valid string buffer.
Result::BufferTooSmall – if outWtk is not big enough to receive all WTK text. See getWellKnownTextLength().
Result::GenericError – if the function failed for any other reason.

◆ getWellKnownTextLength()

virtual FLE_DLL Size FlowEngine::ProjectedCoordinateSystemInterface::getWellKnownTextLength ( ) const

pure virtual

Returns the size necessary to receive the full WTK string of this PCS or 0 if this is not a valid PCS.

◆ importFromWTK()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::importFromWTK ( ConstStringBuffer wtk )

pure virtual

Initializes this PCS information from a Well Known Text (WTK) format.

Parameters

[in] wtk a string buffer containing the WTK string.

Returns

One of the following result codes:

Result::Success – if the function succedeed.
Result::InvalidArgument – if wtk is not a valid string buffer or does not contain a valid WTK format.
Result::GenericError – if the function failed for any other reason.

◆ isValid()

virtual FLE_DLL bool FlowEngine::ProjectedCoordinateSystemInterface::isValid ( ) const

pure virtual

Returns: true if this instance represent a valid Projected Coordinate System, false otherwise. Many methods of this class require that this instance is a valid PCS.

◆ loadFromWellKnownText()

virtual FLE_DLL Result FlowEngine::ProjectedCoordinateSystemInterface::loadFromWellKnownText ( ConstStringBuffer wtk )

pure virtual

Equivalent to importFromWTK.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ProjectedCoordinateSystemInterface()

Member Function Documentation

◆ convertFromGS()

◆ convertToGS()

◆ getEPSGCode()

◆ getEPSGCodeLength()

◆ getGeodeticDatumName()

◆ getGeodeticDatumNameLength()

◆ getName()

◆ getNameLength()

◆ getPrimeMeridianName()

◆ getPrimeMeridianNameLength()

◆ getProjectionName()

◆ getProjectionNameLength()

◆ getProjectionParameters()

◆ getSpheroidName()

◆ getSpheroidNameLength()

◆ getSpheroidParameters()

◆ getUnitName()

◆ getUnitNameLength()

◆ getWellKnownText()

◆ getWellKnownTextLength()

◆ importFromWTK()

◆ isValid()

◆ loadFromWellKnownText()