BDirectTransformer Class Reference

#include <BDirectTransformer.h>

List of all members.


Detailed Description

Abstract base class for objects that perform in-place coordinate transformation of files.

Public Member Functions

 BDirectTransformer ()
 Default constructor.
BCoordTransform GetCoordTransform (void) const
 Get the BCoordTransform currently in use.
const BStringGetDestinationFile (void) const
 Gets the destination file.
BDirectTransformerProxyGetProxy (void) const
 Gets the proxy object used to create and destroy BDataManager-derived objects.
const BStringGetSourceFile (void) const
 Gets the source file.
void SetCoordTransform (const BCoordTransform &ct)
 Set the BCoordTransform that describes how coordinates will be transformed.
void SetDestinationFile (const BString &dest)
 Sets the destination file.
void SetProxy (BDirectTransformerProxy *p)
 Sets the proxy object used to create and destroy BDataManager-derived objects.
void SetSourceFile (const BString &src)
 Sets the source file.
bool SetupCoordTransform (const BCoordSysPtr &pSrcCS, const BCoordSysPtr &pDestCS)
 Sets up the BCoordTransform that describes how the coordinates will be transformed.
virtual void Transform (const BParamList &parms)=0
 Transforms the coordinates in the source file to the target coordinate system and then writes the data to the target file.
virtual ~BDirectTransformer ()
 Destructor.

Static Public Member Functions

static
BDirectTransformer
Create (const BString &type, const BParamList &parms, BLogger *pLogger=0)
 Creates a new BDirectTransformer of the specified type.
static void DestroyObject (BDirectTransformer *pObj)
 Deletes a BDirectTransformer object.

Protected Attributes

BString m_defaultWriteFileExt
 Default file extension to be used if the destination data set is a file and has no extension.
BString m_destFile
 The full path to the destination file.
BCoordTransformPtr m_pCoordTransform
 The BCoordTransform that describes the transformation.
BDirectTransformerProxym_pProxy
 The proxy object used to create and destroy BDataManager-derived objects.
BString m_srcFile
 The full path to the source file.

Constructor & Destructor Documentation

BDirectTransformer (  )  [inline]

Default constructor.

virtual ~BDirectTransformer (  )  [inline, virtual]

Destructor.


Member Function Documentation

static BDirectTransformer* Create ( const BString type,
const BParamList parms,
BLogger pLogger = 0 
) [static]

Creates a new BDirectTransformer of the specified type.

Parameters:
type The type of data source from which data will be read and transformed.
parms Format-specific parameters needed to create the reader.
pLogger Instance of BLogger that will be used to log messages from the reader. This allows the use of a single log file to log messages from all readers and writers in an application. Set this to 0 if you want to allow the reader to create its own log file.
Returns:
The new BDirectTransformer object or NULL if no transformer is available for the specified format.

static void DestroyObject ( BDirectTransformer pObj  )  [static]

Deletes a BDirectTransformer object.

Parameters:
pObj The BDirectTransformer to delete.

BCoordTransform GetCoordTransform ( void   )  const [inline]

Get the BCoordTransform currently in use.

Returns:
The BCoordTransform currently in use.

const BString& GetDestinationFile ( void   )  const [inline]

Gets the destination file.

Returns:
The path to the destination file.

BDirectTransformerProxy* GetProxy ( void   )  const [inline]

Gets the proxy object used to create and destroy BDataManager-derived objects.

Returns:
The proxy object

const BString& GetSourceFile ( void   )  const [inline]

Gets the source file.

Returns:
The path to the source file.

void SetCoordTransform ( const BCoordTransform ct  )  [inline]

Set the BCoordTransform that describes how coordinates will be transformed.

Use the SetupCoordTransform method if you do not wish to construct the BCoordTransform yourself.

Parameters:
ct A fully defined BCoordTransform.

void SetDestinationFile ( const BString dest  ) 

Sets the destination file.

Parameters:
dest The path to the destination file (may be a relative path).

void SetProxy ( BDirectTransformerProxy p  )  [inline]

Sets the proxy object used to create and destroy BDataManager-derived objects.

Parameters:
p The proxy object

void SetSourceFile ( const BString src  ) 

Sets the source file.

Parameters:
src The path to the source file (may be a relative path).

bool SetupCoordTransform ( const BCoordSysPtr pSrcCS,
const BCoordSysPtr pDestCS 
)

Sets up the BCoordTransform that describes how the coordinates will be transformed.

Use the SetCoordTransform method instead if you wish to create the BCoordTransform yourself.

Parameters:
pSrcCS The source coordinate system.
pDestCS The destination coordinate system.

virtual void Transform ( const BParamList parms  )  [pure virtual]

Transforms the coordinates in the source file to the target coordinate system and then writes the data to the target file.

Parameters:
parms Format-specific parameters.


Member Data Documentation

BString m_defaultWriteFileExt [protected]

Default file extension to be used if the destination data set is a file and has no extension.

Derived classes must initialize this in their constructor.

BString m_destFile [protected]

The full path to the destination file.

BCoordTransformPtr m_pCoordTransform [protected]

The BCoordTransform that describes the transformation.

BDirectTransformerProxy* m_pProxy [protected]

The proxy object used to create and destroy BDataManager-derived objects.

BString m_srcFile [protected]

The full path to the source file.


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

GeoTranslate 5.0 From Blue Marble Geographics