FlowEngine::ProjectedCoordinateSystemDB Class Reference

#include <ProjectedCoordinateSystemDB.h>

Static Public Member Functions
static FLE_DLL Result	getEntry (Index index, ProjectedCoordinateSystemInterface &outPCS)
static FLE_DLL Index	getNumberOfEntries ()
static FLE_DLL Result	searchByEPSG (ConstStringBuffer epsgCode, ProjectedCoordinateSystemInterface &outPCS)
static FLE_DLL Result	searchClosestWGS84 (double latitude, double longitude, ProjectedCoordinateSystemInterface &outPCS)

Detailed Description

Utility class that supplies a database of Projected Coordinate Systems.

This database can be queried linearly with the enumeration functions or randomly (e.g. by EPSG id) with the helper functions.

Member Function Documentation

getEntry()

Result FlowEngine::ProjectedCoordinateSystemDB::getEntry ( Index  index, ProjectedCoordinateSystemInterface &  outPCS  )

static

Retrieves the Projected Coordinate System (PCS) in the database at the specified index.

Parameters

[in]	index	the index of the PCS to retrieve. Must be in the range [0, getNumberOfEntries()).
[out]	outPCS	a ProjectedCoordinateSystemInterface object that will receive the requested data.

Returns

One of the following result codes:

• Result::Success – if the function succedeed and outPCS has been filled with the requested information.
• Result::InvalidArgument – if index is not in the valid range.
• Result::FeatureNotAvailable – if this method was called by the free version of the SDK.
• Result::GenericError – if the call failed for any other reason.

getNumberOfEntries()

Index FlowEngine::ProjectedCoordinateSystemDB::getNumberOfEntries ( )

static

Returns

the number of available entries in the database

searchByEPSG()

Result FlowEngine::ProjectedCoordinateSystemDB::searchByEPSG ( ConstStringBuffer  epsgCode, ProjectedCoordinateSystemInterface &  outPCS  )

static

Searches the database and retrieves the Projected Coordinate System (PCS) specified by its European Petroleum Survey Group (EPSG) code, which is usually a 4-5 digits string.

Parameters

[in]	epsgCode	the EPSG code that identifies the required PCS to retrieve.
[out]	outPCS	a ProjectedCoordinateSystemInterface object that will receive the requested data.

Returns

One of the following result codes:

• Result::Success – if the function succedeed and outPCS has been filled with the requested information.
• Result::InvalidArgument – if epsgCode is not a valid string buffer or does not contain a valid EPSG code.
• Result::FeatureNotAvailable – if this method was called by the free version of the SDK.
• Result::GenericError – if the call failed for any other reason.

searchClosestWGS84()

Result FlowEngine::ProjectedCoordinateSystemDB::searchClosestWGS84 ( double  latitude, double  longitude, ProjectedCoordinateSystemInterface &  outPCS  )

static

Searches the database and retrieves the Projected Coordinate System (PCS) which is the closest World Geodetic System 1984 (WGS84) system relative to a specific geodetic coordinates.

Returns

One of the following result codes:

• Result::Success – if the function succedeed.
• Result::InvalidArgument – if epsgCode is not a valid string buffer or does not contain a valid EPSG code.
• Result::FeatureNotAvailable – if this method was called by the free version of the SDK.
• Result::GenericError – if the call failed for any other reason.