/****************************************************************************** * $Id: fme2ogr.h 10646 2007-01-18 02:38:10Z warmerdam $ * * Project:  FMEObjects Translator * Purpose:  Declarations for translating IFMEFeatures to OGRFeatures. * Author:   Frank Warmerdam, warmerdam@pobox.com * ****************************************************************************** * Copyright (c) 1999, 2001 Safe Software Inc. * All Rights Reserved * * This software may not be copied or reproduced, in all or in part,  * without the prior written consent of Safe Software Inc. * * The entire risk as to the results and performance of the software, * supporting text and other information contained in this file * (collectively called the "Software") is with the user.  Although * Safe Software Incorporated has used considerable efforts in preparing  * the Software, Safe Software Incorporated does not warrant the * accuracy or completeness of the Software. In no event will Safe Software  * Incorporated be liable for damages, including loss of profits or  * consequential damages, arising out of the use of the Software. ****************************************************************************/#ifndef _FME2OGR_H_INCLUDED#define _FME2OGR_H_INCLUDED#include "ogrsf_frmts.h"#include "cpl_minixml.h"#include <isession.h>#include <ireader.h>#include <ifeature.h>#include <ifeatvec.h>#include <ipipeline.h>#include <ispatialindex.h>class OGRFMEDataSource;void CPLFMEError( IFMESession *, const char *, ... );/************************************************************************//*                             OGRFMELayer                              *//************************************************************************/class OGRFMELayer : public OGRLayer{  protected:    OGRFeatureDefn     *poFeatureDefn;    OGRSpatialReference *poSpatialRef;    OGRFMEDataSource   *poDS;    char               *pszAttributeFilter;    IFMEFeature         *poFMEFeature;  public:                        OGRFMELayer( OGRFMEDataSource * );    virtual             ~OGRFMELayer();    virtual int         Initialize( IFMEFeature *,                                    OGRSpatialReference * );    virtual OGRErr      SetAttributeFilter( const char * );        OGRSpatialReference *GetSpatialRef();    OGRFeatureDefn *    GetLayerDefn() { return poFeatureDefn; }};/************************************************************************//*                          OGRFMELayerCached                           *//************************************************************************/class OGRFMELayerCached : public OGRFMELayer{  private:    int                 nPreviousFeature;    char               *pszIndexBase;    IFMESpatialIndex   *poIndex;        OGRFeature *        ReadNextIndexFeature();    OGREnvelope         sExtents;    int                 bQueryActive;      public:                       OGRFMELayerCached( OGRFMEDataSource * );    virtual            ~OGRFMELayerCached();                           virtual void        ResetReading();    virtual OGRFeature *GetNextFeature();    virtual int         GetFeatureCount( int bForce );    virtual OGRErr      GetExtent(OGREnvelope *psExtent, int bForce = TRUE);        virtual int         TestCapability( const char * );    int                 AssignIndex( const char *pszBase, const OGREnvelope*,                                     OGRSpatialReference *poSRS );    CPLXMLNode         *SerializeToXML();    int                InitializeFromXML( CPLXMLNode * );};/************************************************************************//*                            OGRFMELayerDB                             *//************************************************************************/class OGRFMELayerDB : public OGRFMELayer{  private:    int                 nPreviousFeature;    IFMEUniversalReader *poReader;    char                *pszReaderName;    char                *pszDataset;    IFMEStringArray     *poUserDirectives;    int                 CreateReader();      public:                       OGRFMELayerDB( OGRFMEDataSource * poDSIn,                                      const char *pszReaderName,                                      const char *pszDataset,                                      IFMEStringArray *poUserDirectives );    virtual            ~OGRFMELayerDB();                           virtual OGRErr      SetAttributeFilter( const char * );        virtual void        ResetReading();    virtual OGRFeature *GetNextFeature();    virtual int         GetFeatureCount( int bForce );    virtual int         TestCapability( const char * );    void                AssignIndex( const char *pszBase );};/************************************************************************//*                           OGRFMEDataSource                           *//************************************************************************/class OGRFMEDataSource : public OGRDataSource{    char                *pszName;          // full name, ie. "SHAPE:D:\DATA"    char                *pszReaderName;    // reader/driver name, ie. "SHAPE"    char                *pszDataset;       // FME dataset name, ie. "D:\DATA"    IFMEStringArray   *poUserDirectives;        IFMESession         *poSession;    IFMEUniversalReader *poReader;    int                 nLayers;    OGRFMELayer         **papoLayers;    IFMEFeature         *poFMEFeature;    int                 ReadFMEFeature();    IFMEString          *poFMEString;    char                *PromptForSource();    char                *ReadFileSource(const char *);    OGRSpatialReference *ExtractSRS();    int                 IsPartOfConnectionCache( IFMEUniversalReader * );    void                OfferForConnectionCaching( IFMEUniversalReader *,                                                   const char *,                                                   const char *);    int                 bUseCaching;    int                 bCoordSysOverride;    void                ClarifyGeometryClass( IFMEFeature *poFeature,                                          OGRwkbGeometryType &eBestGeomType );                                                    public:                        OGRFMEDataSource();                        ~OGRFMEDataSource();    IFMESession *       AcquireSession();    void                ReleaseSession();        int                 TestCapability( const char * );    OGRGeometry        *ProcessGeometry( OGRFMELayer *, IFMEFeature *,                                         OGRwkbGeometryType );    OGRFeature         *ProcessFeature( OGRFMELayer *, IFMEFeature * );    void                ResetReading();    int                 Open( const char * );    const char          *GetName() { return pszName; }    int                 GetLayerCount() { return nLayers; }    OGRLayer            *GetLayer( int );    IFMESession         *GetFMESession() { return poSession; }    IFMEUniversalReader *GetFMEReader() { return poReader; }    void                BuildSpatialIndexes();    OGRSpatialReference *FME2OGRSpatialRef( const char *pszFMECoordsys );        // Stuff related to persistent feature caches.     CPLXMLNode          *SerializeToXML();    int                 InitializeFromXML( CPLXMLNode * );};/************************************************************************//*                             OGRFMEDriver                             *//************************************************************************/class OGRFMEDriver : public OGRSFDriver{  public:                ~OGRFMEDriver();    int                 TestCapability( const char * );    const char *GetName();    OGRDataSource *Open( const char *, int );};/************************************************************************//*                           OGRFMECacheIndex                           *//************************************************************************/class OGRFMECacheIndex{    CPLXMLNode  *psTree;        // Implicitly locked if this is non-NULL.    char        *pszPath;    void        *hLock;  public:                OGRFMECacheIndex( const char *pszPath );                ~OGRFMECacheIndex();    const char *GetPath() { return pszPath; }    int         Load();    int         Save();    CPLXMLNode  *FindMatch( const char *pszDriver,                            const char *pszDataset,                            IFMEStringArray &oUserDirectives );    int         Lock();    int         Unlock();        void        Touch( CPLXMLNode * );    void        Add( CPLXMLNode * );    void        Reference( CPLXMLNode * );    void        Dereference( CPLXMLNode * );        int         ExpireOldCaches( IFMESession * );};// The number of seconds an unreferenced spatial cache should be retained in// the cache index before cleaning up if unused.// Default: 15 minutes#ifndef FMECACHE_RETENTION#  define FMECACHE_RETENTION    900#endif// The number of seconds before a "referenced" data source in the cache// index is considered to be orphaned due to a process dying or something.#ifndef FMECACHE_REF_TIMEOUT#  define FMECACHE_REF_TIMEOUT  FMECACHE_RETENTION*3#endif// The number of seconds from creation a spatial cache should be retained in// the cache index before cleaning it up. // Default: 1hour#ifndef FMECACHE_MAX_RETENTION#  define FMECACHE_MAX_RETENTION    3600   #endifCPL_C_STARTvoid RegisterOGRFME();CPL_C_END#endif /* ndef _FME2OGR_H_INCLUDED */