BCoordinateTransformer Class Reference

#include <BCoordinateTransformer.h>

Inheritance diagram for BCoordinateTransformer:

[legend]

List of all members.

---

Detailed Description

An object that transforms the coordinates in a BLayer.

Public Member Functions
	BCoordinateTransformer (const BCoordSysPtr &pTargCS)
	Constructs a BCoordinateTransformer to transform coordinates to the specified target BCoordSys.
	BCoordinateTransformer ()
	Default constructor.
virtual bool	Get2DTransform (void) const
	Indicates if this is a two-dimensional transformer.
virtual const BCoordTransformSettings &	GetCoordTransformSettings (void) const
	Get the settings and options that will be used during coordinate transformation.
virtual const BCoordSysPtr	GetTargetCoordSys (void) const
	Gets the BCoordSys to which coordinates will be transformed.
virtual bool	HasCoordSys (void) const
	Indicates whether or not a target BCoordSys has been defined for this BCoordinateTransformer.
virtual bool	Process (void)=0
	Processes the coordinates in the BLayer by transforming them to the target coordinate system.
virtual void	Set2DTransform (bool transform2d)
	Specifies if this is a two-dimensional transformer.
virtual void	SetCoordTransformSettings (const BCoordTransformSettings &settings)
	Provide the settings and options that will be used during coordinate transformation.
virtual void	SetTargetCoordSys (const BCoordSysPtr &pTargCS)
	Sets the BCoordSys to which coordinates will be transformed.
Protected Attributes
bool	m_2DTransform
	Indicates if this is a two-dimensional transformer.
BCoordSysPtr	m_pTargetCoordSys
	The coordinate system into which the coordinates will be transformed.
BCoordTransformSettings	m_settings
	Settings and options required to perform a coordinate transformation.

---

Constructor & Destructor Documentation

BCoordinateTransformer

(

)

[inline]

Default constructor.

This constructor will construct an empty BCoordinateTransformer.

BCoordinateTransformer

(

const BCoordSysPtr &

pTargCS

)

[inline]

Constructs a BCoordinateTransformer to transform coordinates to the specified target BCoordSys.

Parameters:

pTargCS

The target coordinate system.

---

Member Function Documentation

virtual bool Get2DTransform

(

void

)

const [inline, virtual]

Indicates if this is a two-dimensional transformer.

A two-dimensional transformer offers a distinct performance advantage over a three-dimensional transformer.

Returns:

True if this is a two-dimensional transformer and false otherwise.

virtual const BCoordTransformSettings& GetCoordTransformSettings

(

void

)

const [inline, virtual]

Get the settings and options that will be used during coordinate transformation.

Returns:

settings The settings and options used during coordinate transformation

virtual const BCoordSysPtr GetTargetCoordSys

(

void

)

const [inline, virtual]

Gets the BCoordSys to which coordinates will be transformed.

Returns:

The target coordinate system.

virtual bool HasCoordSys

(

void

)

const [inline, virtual]

Indicates whether or not a target BCoordSys has been defined for this BCoordinateTransformer.

Returns:

True if a coordinate system has been defined and false otherwise.

virtual bool Process

(

void

)

[pure virtual]

Processes the coordinates in the BLayer by transforming them to the target coordinate system.

Returns:

True if the transformation is successful and false otherwise.

Implements BLayerProcessor.

Implemented in BVectorTransformer.

virtual void Set2DTransform

(

bool

transform2d

)

[inline, virtual]

Specifies if this is a two-dimensional transformer.

A two-dimensional transformer offers a distinct performance advantage over a three-dimensional transformer.

Parameters:

transform2d

A boolean value indicating if this BCoordinateTransformer shall be a two-dimensional transformer. A value of true indicates a two- dimensional transformer and a value of three indicates a three-dimensional transformer.

virtual void SetCoordTransformSettings

(

const BCoordTransformSettings &

settings

)

[inline, virtual]

Provide the settings and options that will be used during coordinate transformation.

Parameters:

settings

The settings and options used during coordinate transformation

virtual void SetTargetCoordSys

(

const BCoordSysPtr &

pTargCS

)

[inline, virtual]

Sets the BCoordSys to which coordinates will be transformed.

Parameters:

pTargCS

The target coordinate system.

---

Member Data Documentation

bool m_2DTransform [protected]

Indicates if this is a two-dimensional transformer.

If this is set to true, then only x and y coordinates will be transformed. Z coordinate data will be ignored if present.

BCoordSysPtr m_pTargetCoordSys [protected]

The coordinate system into which the coordinates will be transformed.

BCoordTransformSettings m_settings [protected]

Settings and options required to perform a coordinate transformation.

---

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

• BCoordinateTransformer.h

---

GeoTranslate 5.0 From Blue Marble Geographics