/*-*-C++-*-*//****************************************************************************** * $Id: ogr_tiger.h 10646 2007-01-18 02:38:10Z warmerdam $ * * Project:  TIGER/Line Translator * Purpose:  Main declarations for Tiger translator. * Author:   Frank Warmerdam, warmerdam@pobox.com * ****************************************************************************** * Copyright (c) 1999, Frank Warmerdam * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. ****************************************************************************/#ifndef _OGR_TIGER_H_INCLUDED#define _OGR_TIGER_H_INCLUDED#include "cpl_conv.h"#include "ogrsf_frmts.h"class OGRTigerDataSource;/*** TIGER Versions**** 0000           TIGER/Line Precensus Files, 1990** 0002           TIGER/Line Initial Voting District Codes Files, 1990** 0003           TIGER/Line Files, 1990** 0005           TIGER/Line Files, 1992** 0021           TIGER/Line Files, 1994** 0024           TIGER/Line Files, 1995** 0697 to 1098   TIGER/Line Files, 1997** 1298 to 0499   TIGER/Line Files, 1998** 0600 to 0800   TIGER/Line Files, 1999** 1000 to 1100   TIGER/Line Files, Redistricting Census 2000** 0301 to 0801   TIGER/Line Files, Census 2000**** 0302 to 0502   TIGER/Line Files, UA 2000** ????    ????**** 0602  & higher TIGER/Line Files, 2002** ????    ????*/typedef enum {    TIGER_1990_Precensus = 0,    TIGER_1990 = 1,    TIGER_1992 = 2,    TIGER_1994 = 3,    TIGER_1995 = 4,    TIGER_1997 = 5,    TIGER_1998 = 6,    TIGER_1999 = 7,    TIGER_2000_Redistricting = 8,    TIGER_2000_Census = 9,    TIGER_UA2000 = 10,    TIGER_2002 = 11,    TIGER_2003 = 12,    TIGER_2004 = 13,    TIGER_Unknown} TigerVersion;TigerVersion TigerClassifyVersion( int );char * TigerVersionString( TigerVersion );/*****************************************************************************//* The TigerFieldInfo and TigerRecordInfo structures hold information about  *//* the schema of a TIGER record type.  In each layer implementation file     *//* there are statically initalized variables of these types that describe    *//* the record types associated with that layer.  In the case where different *//* TIGER versions have different schemas, there is a                         *//* TigerFieldInfo/TigerRecordInfo for each version, and the constructor      *//* for the layer chooses a pointer to the correct set based on the version.  *//*****************************************************************************/typedef struct TigerFieldInfo {  char         *pszFieldName;   // name of the field  char          cFmt;           // format of the field ('L' or 'R')  char          cType;          // type of the field ('A' or 'N')  OGRFieldType  OGRtype;        // OFTType of the field (OFTInteger, OFTString, ...?)  int           nBeg;           // beginning column number for field  int           nEnd;           // ending column number for field  int           nLen;           // length of field  int           bDefine;        // whether to add this field to the FeatureDefn  int           bSet;           // whether to set this field in GetFeature()  int           bWrite;         // whether to write this field in CreateFeature()} TigerFieldInfo;typedef struct TigerRecordInfo {  TigerFieldInfo *pasFields;  int             nFieldCount;  int             nRecordLength;} TigerRecordInfo;// OGR_TIGER_RECBUF_LEN should be a number that is larger than the// longest possible record length for any record type; it's used to// create arrays to hold the records.  At the time of this writing the// longest record (RT1) has length 228, but I'm choosing 500 because// it's a good round number and will allow for growth without having// to modify this file.  The code never holds more than a few records// in memory at a time, so having OGR_TIGER_RECBUF_LEN be much larger// than is really necessary won't affect the amount of memory required// in a substantial way.// mbp Fri Dec 20 19:19:59 2002#define OGR_TIGER_RECBUF_LEN 500/************************************************************************//*                            TigerFileBase                             *//************************************************************************/class TigerFileBase{protected:  OGRTigerDataSource  *poDS;  char                *pszModule;  char                *pszShortModule;  FILE                *fpPrimary;  OGRFeatureDefn      *poFeatureDefn;  int                 nFeatures;  int                 nRecordLength;  int                 OpenFile( const char *, const char * );  void                EstablishFeatureCount();  static int          EstablishRecordLength( FILE * );  void                SetupVersion();  int                 nVersionCode;  TigerVersion        nVersion;public:                      TigerFileBase();  virtual            ~TigerFileBase();  TigerVersion        GetVersion() { return nVersion; }  int                 GetVersionCode() { return nVersionCode; }  virtual const char *GetShortModule() { return pszShortModule; }  virtual const char *GetModule() { return pszModule; }  virtual int         SetModule( const char * ) = 0;  virtual int         SetWriteModule( const char *, int, OGRFeature * );  virtual int         GetFeatureCount() { return nFeatures; }  virtual OGRFeature *GetFeature( int ) = 0;  virtual OGRErr      CreateFeature( OGRFeature *poFeature )                                { return OGRERR_FAILURE; }  OGRFeatureDefn     *GetFeatureDefn() { return poFeatureDefn; }  static const char * GetField( const char *, int, int );  static void         SetField( OGRFeature *, const char *, const char *,                                int, int );  int                 WriteField( OGRFeature *, const char *, char *,                                  int, int, char, char );  int                 WriteRecord( char *pachRecord, int nRecLen,                                   const char *pszType, FILE *fp = NULL );  int                 WritePoint( char *pachRecord, int nStart,                                  double dfX, double dfY ); protected:  void                WriteFields(TigerRecordInfo *psRTInfo,                                  OGRFeature      *poFeature,                                  char            *szRecord);  void                AddFieldDefns(TigerRecordInfo *psRTInfo,                                    OGRFeatureDefn  *poFeatureDefn);  void                SetFields(TigerRecordInfo *psRTInfo,                                OGRFeature      *poFeature,                                char            *achRecord);};/************************************************************************//*                          TigerCompleteChain                          *//************************************************************************/class TigerCompleteChain : public TigerFileBase{  FILE               *fpShape;  int                *panShapeRecordId;  FILE               *fpRT3;  int                 bUsingRT3;  int                 nRT1RecOffset;  int                 GetShapeRecordId( int, int );  int                 AddShapePoints( int, int, OGRLineString *, int );  void                AddFieldDefnsPre2002();  OGRFeature         *GetFeaturePre2002( int );  OGRErr              WriteRecordsPre2002( OGRFeature *, OGRLineString * );  OGRErr              WriteRecords2002( OGRFeature *, OGRLineString * );  OGRFeature         *GetFeature2002( int );  void                AddFieldDefns2002();  TigerRecordInfo    *psRT1Info;  TigerRecordInfo    *psRT2Info;  TigerRecordInfo    *psRT3Info;public:                      TigerCompleteChain( OGRTigerDataSource *,                                          const char * );  virtual            ~TigerCompleteChain();  virtual int         SetModule( const char * );  virtual OGRFeature *GetFeature( int );  virtual OGRErr      CreateFeature( OGRFeature *poFeature );  virtual int         SetWriteModule( const char *, int, OGRFeature * );};/************************************************************************//*                    TigerAltName (Type 4 records)                     *//************************************************************************/class TigerAltName : public TigerFileBase{ private:  TigerRecordInfo    *psRT4Info; public:                      TigerAltName( OGRTigerDataSource *,                                          const char * );  virtual            ~TigerAltName();  virtual int         SetModule( const char * );  virtual OGRFeature *GetFeature( int );  virtual OGRErr      CreateFeature( OGRFeature *poFeature );};/************************************************************************//*                    TigerFeatureIds (Type 5 records)                  *//************************************************************************/class TigerFeatureIds : public TigerFileBase{ private:  TigerRecordInfo    *psRT5Info; public:                      TigerFeatureIds( OGRTigerDataSource *,                                       const char * );  virtual            ~TigerFeatureIds();  virtual int         SetModule( const char * );  virtual OGRFeature *GetFeature( int );  virtual OGRErr      CreateFeature( OGRFeature *poFeature );};/************************************************************************//*                    TigerZipCodes (Type 6 records)                    *//************************************************************************/class TigerZipCodes : public TigerFileBase{ private:  TigerRecordInfo    *psRT6Info;public:                      TigerZipCodes( OGRTigerDataSource *, const char * );  virtual            ~TigerZipCodes();  virtual int         SetModule( const char * );  virtual OGRFeature *GetFeature( int );  virtual OGRErr      CreateFeature( OGRFeature *poFeature );};/************************************************************************//*                    TigerPoint                                        *//* This is an abstract base class for TIGER layers with point geometry. *//* Since much of the implementation of these layers is similar, I've    *//* put it into this base class to avoid duplication in the actual       *//* layer classes.  mbp Sat Jan  4 16:41:19 2003.                        *//************************************************************************/class TigerPoint : public TigerFileBase{ protected:                      TigerPoint(int bRequireGeom);                      // The boolean bRequireGeom indicates whether                      // the layer requires each feature to actual                      // have a geom.  It's used in CreateFeature() to                      // decide whether to report an error when a                      // missing geom is detected.  virtual             ~TigerPoint(); private: int                  bRequireGeom; public:  virtual int         SetModule( const char *,                                 char *pszFileCode );  virtual OGRFeature *GetFeature( int              nRecordId,                                  TigerRecordInfo *psRTInfo,                                  int nX0, int nX1,                                  int nY0, int nY1 );  virtual OGRErr CreateFeature( OGRFeature      *poFeature,                                TigerRecordInfo *psRTInfo,                                int nIndex,                                char *pszFileCode );};/************************************************************************//*                   TigerLandmarks (Type 7 records)                    *//************************************************************************/class TigerLandmarks : public TigerPoint{ private:  TigerRecordInfo    *psRT7Info; public:                      TigerLandmarks( OGRTigerDataSource *, const char * );  virtual            ~TigerLandmarks();  virtual int         SetModule( const char * );  virtual OGRFeature *GetFeature( int );  virtual OGRErr      CreateFeature( OGRFeature *poFeature );};/************************************************************************//*                   TigerAreaLandmarks (Type 8 records)                *//************************************************************************/class TigerAreaLandmarks : public TigerFileBase{ private:  TigerRecordInfo    *psRT8Info;public:                      TigerAreaLandmarks( OGRTigerDataSource *, const char * );  virtual            ~TigerAreaLandmarks();  virtual int         SetModule( const char * );  virtual OGRFeature *GetFeature( int );  virtual OGRErr      CreateFeature( OGRFeature *poFeature );};/************************************************************************//*                   TigerKeyFeatures (Type 9 records)                  *//************************************************************************/class TigerKeyFeatures : public TigerFileBase{ private:  TigerRecordInfo    *psRT9Info;