GeoCore::BDirectTransformerProxy

BDirectTransformerProxy Class Reference

#include <BDirectTransformerProxy.h>

List of all members.

Detailed Description

The "plug-in" interface for data format transformer dynamic libraries.

Public Member Functions

 BDirectTransformerProxy ()
 Default constructor.
virtual bool CanTransform (const BString &dataType)
 Indicates if the transformer library can transform a file of the specified type.
virtual
BDirectTransformer * 		CreateTransformer (const BString &type, const BParamList &createParms, BCoordSysRepository *ds, BLogger *pLogger=0)
 Factory method to create a BDirectTransformer object.
virtual void DestroyObject (BDirectTransformer *pObj)
 Destroys a BDirectTransformer object.
int GetBuildNumber ()
 Retrieves the global build number used to identify build version for this format reader writer or transformer.
virtual ~BDirectTransformerProxy ()
 Destructor.

Protected Member Functions

void Initialize (BDirectTransformer *pMgr, BCoordSysRepository *ds, BLogger *pLogger=0)
 Initializes a BDirectTransformerProxy.

Constructor & Destructor Documentation

BDirectTransformerProxy (  )  [inline]

Default constructor.

Since this object is just an interface, it is not very useful to create a raw BDirectTransformerProxy. Each format library implements an object that supports this interface, and GeoCore takes care constructing these objects.

virtual ~BDirectTransformerProxy (  )  [inline, virtual]

Destructor.

Member Function Documentation

virtual bool CanTransform ( const BString &  dataType  )  [inline, virtual]

Indicates if the transformer library can transform a file of the specified type.

Parameters:
dataType The format that will be transformed. Possible values for this parameter are provided as BString constants in DSType.h.
Returns:
True if the library can transfrom a file of the specifed format and false otherwise.

virtual BDirectTransformer* CreateTransformer ( const BString &  type,
const BParamList &  createParms,
BCoordSysRepository *  ds,
BLogger *  pLogger = 0 
) [virtual]

Factory method to create a BDirectTransformer object.

Parameters:
type The data type that the BDirectTransformer will accept.
createParms Format-specific parameters.
ds The BCoordSysRepository that the BDirectTransformer will use to retreive geodetic definitions.
pLogger Instance of BLogger that will be used to log messages from the transformer. This allows the use of a single log file to log messages from all readers, writers, and transformers in an application. Set this to 0 if you want to allow the transformer to create its own log file.
Returns:
A BDirectTransformer that will transform data of the specified format.

virtual void DestroyObject ( BDirectTransformer *  pObj  )  [virtual]

Destroys a BDirectTransformer object.

Parameters:
pObj The BDirectTransformer to delete.

int GetBuildNumber (  ) 

Retrieves the global build number used to identify build version for this format reader writer or transformer.

void Initialize ( BDirectTransformer *  pMgr,
BCoordSysRepository *  ds,
BLogger *  pLogger = 0 
) [protected]

Initializes a BDirectTransformerProxy.

Parameters:
pMgr The BDirectTransformer that owns this proxy.
ds The BCoordSysRepository that this BDirectTransformerProxy will use to retreive geodetic definitions.
pLogger The BLogger to which log messages will be written.

The documentation for this class was generated from the following file:
GeoTranslate 5.0 From Blue Marble Geographics