A Converter is responsible for the conversion of coordinates between different Coordinate Systems (CS). More...

#include <Converter.h>

Public Member Functions
bool	convert (double xIn, double yIn, double xOut, double yOut, long numCoord, int coordOffset=1) const
	Converts a vector of coordinates from source SRS to target SRS. More...

bool	convert (double x, double y, long numCoord, int coordOffset=1) const
	Converts a vector of coordinates from source SRS to target SRS. More...

bool	convert (const double xIn, const double yIn, double &xOut, double &yOut) const
	Converts a single coordinate from source SRS to target SRS. More...

bool	convert (double &x, double &y) const
	Converts a coordinate from source SRS to target SRS. More...

	Converter ()
	Default empty constructor. More...

	Converter (int sourceSRID, int targetSRID)
	Constructor with parameters. More...

bool	convertToGeographic (double &x, double &y, int SRID) const
	Converts a coordinate from a projected SRS to its underlying geographic SRS (same Datum). More...

bool	convertToProjected (double &lon, double &lat, int SRID) const
	Converts a coordinate from a geographic SRS to a projected SRS based on the same Datum. More...

int	getSourceSRID () const
	Gets source SRS identifier. More...

int	getTargetSRID () const
	Gets target SRS identifier. More...

bool	invert (double xIn, double yIn, double xOut, double yOut, long numCoord, int coordOffset=1) const
	Inverts a vector of coordinates from target SRS to dource SRS. More...

bool	invert (double x, double y, long numCoord, int coordOffset=1) const
	Inverts a vector of coordinates from target SRS to source SRS. More...

bool	invert (const double xIn, const double yIn, double &xOut, double &yOut) const
	Inverts a coordinate from source SRS to target SRS. More...

bool	invert (double &x, double &y) const
	Inverts a coordinate from target SRS to source SRS. More...

void	setSourcePJ4txt (const std::string &pj4txt)
	Sets the source SRS PROJ4 description. More...

void	setSourceSRID (int sourceSRID)
	Sets the source SRS identifier. More...

void	setTargetPJ4txt (const std::string &pj4txt)
	Sets the target SRS PROJ4 description. More...

void	setTargetSRID (int targetSRID)
	Sets the target SRS identifier. More...

	~Converter ()
	Destructor. More...

Private Attributes
void *	m_sourcePj4Handler

int	m_sourceSRID

void *	m_targetPj4Handler

int	m_targetSRID

Detailed Description

A Converter is responsible for the conversion of coordinates between different Coordinate Systems (CS).

A Converter is responsible for the conversion of coordinates between two different Coordinate Systems (CS) or a Spatial Reference System (SRS). A CS can be uniquely identified by a numeric code (SRID). This implementation is based on the PROJ4 cartographic library and only works if it has been enabled.

Definition at line 53 of file Converter.h.

Constructor & Destructor Documentation

te::srs::Converter::Converter ( )

Default empty constructor.

te::srs::Converter::Converter	(	int	sourceSRID,
		int	targetSRID
	)

Constructor with parameters.

Parameters

sourceSRID	source SRS identifier (input).
targetSRID	target SRS identifier (input).

Exceptions

te::srs::Exception identifier not recognized.

te::srs::Converter::~Converter ( )

Destructor.

Member Function Documentation

bool te::srs::Converter::convert	(	double *	xIn,
		double *	yIn,
		double *	xOut,
		double *	yOut,
		long	numCoord,
		int	coordOffset = `1`
	)		const

Converts a vector of coordinates from source SRS to target SRS.

The X and Y dimensions of the coordinates are given in separate vectors. Output vectors must be previously allocaded by the caller of this method and caller is responsible for deallocating them.

Parameters

xIn	pointer to array of X values in source SRS (input).
yIn	pointer to array of Y valueS in source SRS (input).
xOut	pointer to array of X values in target SRS (output).
yOut	pointer to array of X values in target SRS (output).
numCoord	number of coordinates in the input arrays (input).
coordOffset	the step size from value to value (measured in doubles) within the xIn/yIn arrays (input).

Returns: true if succeed and false otherwise.

bool te::srs::Converter::convert	(	double *	x,
		double *	y,
		long	numCoord,
		int	coordOffset = `1`
	)		const

Converts a vector of coordinates from source SRS to target SRS.

Parameters

x	pointer to array of X values in source SRS as input and modified to target SRS for output.
y	pointer to array of Y valueS in source SRS as input and modified to target SRS for output.
numCoord	number of coordinates in the array (input).
coordOffset	the step size from value to value (measured in doubles) within the x/y arrays (input).

Returns: true if succeed and false otherwise.

bool te::srs::Converter::convert	(	const double	xIn,
		const double	yIn,
		double &	xOut,
		double &	yOut
	)		const

Converts a single coordinate from source SRS to target SRS.

Parameters

xIn	coordinate X value in source SRS (input).
yIn	coordinate Y value in source SRS (input).
xOut	coordinate X value in target SRS (output).
yOut	coordinate Y values in target SRS (output).

Returns: true if succeed and false otherwise.

bool te::srs::Converter::convert	(	double &	x,
		double &	y
	)		const

Converts a coordinate from source SRS to target SRS.

Parameters

x	X value in source SRS as input and modified to target SRS for output.
y	Y value in source SRS as input and modified to target SRS for output.

Returns: true if succeed and false otherwise.

bool te::srs::Converter::convertToGeographic	(	double &	x,
		double &	y,
		int	SRID
	)		const

Converts a coordinate from a projected SRS to its underlying geographic SRS (same Datum).

Parameters

x	projected X-coordinate. Will return the geographic longitude coordinate.
y	projected Y-coordinate. Will return the geographic latitude coordinate.
SRID	projected SRS identifier that x and y refers to.

Returns: true if succeed and false otherwise.

bool te::srs::Converter::convertToProjected	(	double &	lon,
		double &	lat,
		int	SRID
	)		const

Converts a coordinate from a geographic SRS to a projected SRS based on the same Datum.

Parameters

lon	geographic longitude. Will return the projected x-coordinate.
lat	geogrpahic latitude. Will return the projected y-coordinate.
SRID	target projected SRS identifier.

Returns: true if succeed and false otherwise.

int te::srs::Converter::getSourceSRID ( ) const

Gets source SRS identifier.

int te::srs::Converter::getTargetSRID ( ) const

Gets target SRS identifier.

bool te::srs::Converter::invert	(	double *	xIn,
		double *	yIn,
		double *	xOut,
		double *	yOut,
		long	numCoord,
		int	coordOffset = `1`
	)		const

Inverts a vector of coordinates from target SRS to dource SRS.

The X and Y dimensions of the coordinates are given in separate vectors. Output vectors must be previously allocaded by the caller of this method, and caller is responsible for deallocating them.

Parameters

xIn	pointer to array of X values in target SRS (input).
yIn	pointer to array of Y valueS in target SRS (input).
xOut	pointer to array of X values in source SRS (output).
yOut	pointer to array of Y values in source SRS (output).
numCoord	number of coordinates in the array (input).
coordOffset	the step size from value to value (in double size) within the x/y arrays (input).

Returns: true if succeed and false otherwise.

bool te::srs::Converter::invert	(	double *	x,
		double *	y,
		long	numCoord,
		int	coordOffset = `1`
	)		const

Inverts a vector of coordinates from target SRS to source SRS.

Parameters

x	pointer to array of X values in target SRS as input and modified to source SRS for output.
y	pointer to array of Y values in target SRS as input and modified to source SRS for output.
numCoord	number of coordinates in the array (input).
coordOffset	the step size from value to value in double size) within the x/y arrays (input).

Returns: true if succeed and false otherwise.

bool te::srs::Converter::invert	(	const double	xIn,
		const double	yIn,
		double &	xOut,
		double &	yOut
	)		const

Inverts a coordinate from source SRS to target SRS.

Parameters

xIn	pointer to array of X values in target SRS (input).
yIn	pointer to array of Y valueS in target SRS (input).
xOut	pointer to array of X values in source SRS (output).
yOut	pointer to array of Y values in source SRS (output).

Returns: true if succeed and false otherwise.

bool te::srs::Converter::invert	(	double &	x,
		double &	y
	)		const

Inverts a coordinate from target SRS to source SRS.

Parameters

x	pointer to array of X values in target SRS as inputand modified to source SRS for output.
y	pointer to array of Y values in target SRS as inputand modified to source SRS for output.

Returns: true if succeed and false otherwise.

void te::srs::Converter::setSourcePJ4txt ( const std::string & pj4txt )

Sets the source SRS PROJ4 description.

Parameters

pj4txt PROJ4 description (input). Do not pass an empty string.

Exceptions

te::srs::Exception PROJ4 description is not valid.

void te::srs::Converter::setSourceSRID ( int sourceSRID )

Sets the source SRS identifier.

Parameters

sourceSRID the source SRS identifier (input).

Exceptions

te::srs::Exception identifier not recognized.

void te::srs::Converter::setTargetPJ4txt ( const std::string & pj4txt )

Sets the target SRS PROJ4 description.

Parameters

pj4txt PROJ4 description (input). Do not pass an empty string.

Exceptions

te::srs::Exception PROJ4 description is not valid.

void te::srs::Converter::setTargetSRID ( int targetSRID )

Sets the target SRS identifier.

Parameters

targetSRID the target SRS identifier (input).

Exceptions

te::srs::Exception identifier not recognized.

Member Data Documentation

void* te::srs::Converter::m_sourcePj4Handler

private

Definition at line 217 of file Converter.h.

int te::srs::Converter::m_sourceSRID

private

Definition at line 215 of file Converter.h.

void* te::srs::Converter::m_targetPj4Handler

private

Definition at line 218 of file Converter.h.

int te::srs::Converter::m_targetSRID

private

Definition at line 214 of file Converter.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/srs/Converter.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation