BCoordTransform Class Reference

#include <BCoordTransform.h>

Inheritance diagram for BCoordTransform:

[legend]

List of all members.

---

Detailed Description

Encapsulates the properties of a tranformation from one coordinate system to another.

Public Member Functions
	BCoordTransform (const BCoordTransform &ct)
	Copy constructor.
	BCoordTransform (const BCoordSysPtr &pSrc, const BCoordSysPtr &pTarg, const BCoordTransformSettings &transformSettings, bool optimizeFor2D=false)
	Constructor.
bool	ConvertSourceToTarget (double &x, double &y) const
	Converts a point currently in the source coordinate system to the target coordinate system.
BPoint	ConvertSourceToTarget (const BPoint &inPt) const
	Converts a point currently in the source coordinate system to the target coordinate system.
bool	ConvertTargetToSource (double &x, double &y) const
	Converts a point currently in the target coordinate system to the source coordinate system.
BPoint	ConvertTargetToSource (const BPoint &inPt) const
	Converts a point currently in the target coordinate system to the source coordinate system.
bool	CopyDatumShift (const BCoordTransform &ct)
	Copies the datum shift collection from the specified BCoordTransform into this one.
const BCoordTransformSettings &	GetCoordTransformSettings (void) const
	Gets the current coordinate transformation settings.
EDatumShiftStateType	GetDatumShiftStateType () const
	Gets the state of the attempt to establish a datum shift.
BDatumShiftInfoVector	GetDSInfo ()
	Gets the details of the datum shift(s) used by thie BCoordTransform.
GeoCalc::CT::CCoordTransform *	GetGCTransform ()
	Gets the GeoCalcCore CCoordTransform that underlies this BCoordTransform.
BCoordSysPtr	GetSourceCoordSys (void) const
	Gets the source coordinate system.
BCoordSysPtr	GetTargetCoordSys (void) const
	Gets the target coordinate system.
virtual ETransformType	GetType () const
	Indicates the type of this BTransform.
bool	IsValid (void) const
	Indicates whether or not this BCoordTransform object is valid.
bool	operator!= (const BCoordTransform &rhs) const
	Inequality operator.
BCoordTransform &	operator= (const BCoordTransform &rhs)
	Assignment operator.
bool	operator== (const BCoordTransform &rhs) const
	Equality operator.
void	SetSourceCoordSys (const BCoordSysPtr &pcs)
	Sets the source coordinate system.
void	SetTargetCoordSys (const BCoordSysPtr &pcs)
	Sets the target coordinate system.
virtual	~BCoordTransform ()
	Destructor.
Friends
class	BCoordSysRepository

---

Constructor & Destructor Documentation

BCoordTransform	(	const BCoordSysPtr &	pSrc,
		const BCoordSysPtr &	pTarg,
		const BCoordTransformSettings &	transformSettings,
		bool	optimizeFor2D = false
	)

Constructor.

Parameters:

	pSrc	The source coordinate system.
	pTarg	The target coordinate system.
	transformSettings	An object containing various settings regarding the datum shift selection.
	optimizeFor2D	Only convert two-dimensional data (x,y). This can offer a performance advantage over doing a three-dimensional transformation.

BCoordTransform

(

const BCoordTransform &

ct

)

Copy constructor.

Parameters:

ct

BCoordTransform to copy.

virtual ~BCoordTransform

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool ConvertSourceToTarget	(	double &	x,
		double &	y
	)			const [virtual]

Converts a point currently in the source coordinate system to the target coordinate system.

Parameters:

	x	The x-coordinate of the point in the source coordinate system. After this method returns, this parameter will hold the resulting x-coordinate of the point in the target coordinate system.
	y	The y-coordinate of the point in the source coordinate system. After this method returns, this parameter will hold the resulting y-coordinate of the point in the target coordinate system.

Returns:

True if this method is successful and false otherwise.

Implements BTransform.

BPoint ConvertSourceToTarget

(

const BPoint &

inPt

)

const [virtual]

Converts a point currently in the source coordinate system to the target coordinate system.

Parameters:

inPt

A point in the source coordinate system.

Returns:

A point in the target coordinate system.

Implements BTransform.

bool ConvertTargetToSource	(	double &	x,
		double &	y
	)			const [virtual]

Converts a point currently in the target coordinate system to the source coordinate system.

Parameters:

	x	The x-coordinate of the point in the target coordinate system. After this method returns, this parameter will hold the resulting x-coordinate of the point in the source coordinate system.
	y	The y-coordinate of the point in the target coordinate system. After this method returns, this parameter will hold the resulting y-coordinate of the point in the source coordinate system.

Returns:

True if this method is successful and false otherwise.

Implements BTransform.

BPoint ConvertTargetToSource

(

const BPoint &

inPt

)

const [virtual]

Converts a point currently in the target coordinate system to the source coordinate system.

Parameters:

inPt

A point in the target coordinate system.

Returns:

A point in the source coordinate system.

Implements BTransform.

bool CopyDatumShift

(

const BCoordTransform &

ct

)

Copies the datum shift collection from the specified BCoordTransform into this one.

Parameters:

ct

The BCoordTransform from which datum shift(s) shall be copied.

Returns:

True if the method is successful and false otherwise.

const BCoordTransformSettings& GetCoordTransformSettings

(

void

)

const [inline]

Gets the current coordinate transformation settings.

Returns:

The coordinate transformation settings, containing various settings regarding the datum shift selection.

EDatumShiftStateType GetDatumShiftStateType

(

)

const

Gets the state of the attempt to establish a datum shift.

The attempt to establish a datum shift is made when this object is constructed.

Returns:

The datum shift state.

BDatumShiftInfoVector GetDSInfo

(

)

Gets the details of the datum shift(s) used by thie BCoordTransform.

Returns:

The details of this BCoordTransform's datum shifts.

GeoCalc::CT::CCoordTransform* GetGCTransform

(

)

Gets the GeoCalcCore CCoordTransform that underlies this BCoordTransform.

Returns:

The GeoCalcCore CCoordTransform.

BCoordSysPtr GetSourceCoordSys

(

void

)

const

Gets the source coordinate system.

Returns:

The source coordinate system.

BCoordSysPtr GetTargetCoordSys

(

void

)

const

Gets the target coordinate system.

Returns:

The target coordinate system

virtual ETransformType GetType

(

)

const [inline, virtual]

Indicates the type of this BTransform.

Returns:

The type of this BTransform.

Implements BTransform.

bool IsValid

(

void

)

const [virtual]

Indicates whether or not this BCoordTransform object is valid.

A BCoordTransform is considered valid if it has valid source and target coordinate systems. This does not check the result of the attempt to establish a datum shift.

Returns:

True if this BCoordTransform object is valid and false otherwise.

Implements BTransform.

bool operator!=

(

const BCoordTransform &

rhs

)

const

Inequality operator.

Parameters:

rhs

The BCoordTransform to test for inequality.

Returns:

True if the specified BCoordTransform does not have the same value as this one and false otherwise.

BCoordTransform& operator=

(

const BCoordTransform &

rhs

)

Assignment operator.

Parameters:

rhs

The BCoordTransform whose value shall be copied into this one.

Returns:

A reference to this BCoordTransform.

bool operator==

(

const BCoordTransform &

rhs

)

const

Equality operator.

Parameters:

rhs

The BCoordTransform to test for equality.

Returns:

True if the specified BCoordTransform has the same value as this one and false otherwise.

void SetSourceCoordSys

(

const BCoordSysPtr &

pcs

)

Sets the source coordinate system.

Parameters:

pcs

The source coordinate system.

void SetTargetCoordSys

(

const BCoordSysPtr &

pcs

)

Sets the target coordinate system.

Parameters:

pcs

The target coordinate system.

---

Friends And Related Function Documentation

friend class BCoordSysRepository [friend]

---

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

• BCoordTransform.h

---

GeoTranslate 5.0 From Blue Marble Geographics