- Main Page
- Classes
- Files
- Directories
- Related Pages

- File List
- File Members

# ogr_feature.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * $Id: ogr_feature.h,v 1.33 2006/04/02 18:25:59 fwarmerdam Exp $
    00003  *
    00004  * Project:  OpenGIS Simple Features Reference Implementation
    00005  * Purpose:  Class for representing a whole feature, and layer schemas.
    00006  * Author:   Frank Warmerdam, warmerdam@pobox.com
    00007  *
    00008  ******************************************************************************
    00009  * Copyright (c) 1999,  Les Technologies SoftMap Inc.
    00010  *
    00011  * Permission is hereby granted, free of charge, to any person obtaining a
    00012  * copy of this software and associated documentation files (the "Software"),
    00013  * to deal in the Software without restriction, including without limitation
    00014  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
    00015  * and/or sell copies of the Software, and to permit persons to whom the
    00016  * Software is furnished to do so, subject to the following conditions:
    00017  *
    00018  * The above copyright notice and this permission notice shall be included
    00019  * in all copies or substantial portions of the Software.
    00020  *
    00021  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
    00022  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00023  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    00024  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00025  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    00026  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    00027  * DEALINGS IN THE SOFTWARE.
    00028  ******************************************************************************
    00029  *
    00030  * $Log: ogr_feature.h,v $
    00031  * Revision 1.33  2006/04/02 18:25:59  fwarmerdam
    00032  * added OFTDateTime, and OFTTime support
    00033  *
    00034  * Revision 1.32  2006/02/15 04:25:37  fwarmerdam
    00035  * added date support
    00036  *
    00037  * Revision 1.31  2005/09/21 00:50:08  fwarmerdam
    00038  * Added Release
    00039  *
    00040  * Revision 1.30  2005/08/30 23:52:35  fwarmerdam
    00041  * implement preliminary OFTBinary support
    00042  *
    00043  * Revision 1.29  2004/02/23 21:47:23  warmerda
    00044  * Added GetUsedFields() and GetSWGExpr() methods on OGRFeatureQuery class
    00045  *
    00046  * Revision 1.28  2003/05/28 19:16:42  warmerda
    00047  * fixed up argument names and stuff for docs
    00048  *
    00049  * Revision 1.27  2003/04/08 20:57:28  warmerda
    00050  * added RemapFields on OGRFeature
    00051  *
    00052  * Revision 1.26  2003/03/04 05:46:31  warmerda
    00053  * added EvaluateAgainstIndices for OGRFeatureQuery
    00054  *
    00055  * Revision 1.25  2003/01/08 22:03:44  warmerda
    00056  * added StealGeometry() method on OGRFeature
    00057  *
    00058  * Revision 1.24  2002/10/09 14:31:06  warmerda
    00059  * dont permit negative widths to be assigned to field definition
    00060  *
    00061  * Revision 1.23  2002/09/26 18:13:17  warmerda
    00062  * moved some defs to ogr_core.h for sharing with ogr_api.h
    00063  *
    00064  * Revision 1.22  2002/08/07 21:37:47  warmerda
    00065  * added indirect OGRFeaturedefn constructor/destructor
    00066  *
    00067  * Revision 1.21  2001/11/01 16:54:16  warmerda
    00068  * added DestroyFeature
    00069  *
    00070  * Revision 1.20  2001/07/19 18:25:07  warmerda
    00071  * expanded tabs
    00072  *
    00073  * Revision 1.19  2001/06/19 15:48:36  warmerda
    00074  * added feature attribute query support
    00075  *
    00076  * Revision 1.18  2001/06/01 14:33:00  warmerda
    00077  * added CreateFeature factory method
    00078  *
    00079  * Revision 1.17  2001/02/06 17:10:28  warmerda
    00080  * export entry points from DLL
    00081  *
    00082  * Revision 1.16  2001/01/19 21:10:47  warmerda
    00083  * replaced tabs
    00084  *
    00085  * Revision 1.15  2000/12/07 03:40:13  danmo
    00086  * Removed stray comma in OGRFieldType enum defn
    00087  *
    00088  * Revision 1.14  2000/10/03 19:19:56  danmo
    00089  * Made m_pszStyleString protected (was private)
    00090  *
    00091  * Revision 1.13  2000/10/03 18:14:29  danmo
    00092  * Made OGRFeature::Get/SetStyleString() virtual
    00093  *
    00094  * Revision 1.12  2000/08/18 21:26:53  svillene
    00095  * Add representation
    00096  *
    00097  * Revision 1.11  1999/11/26 03:05:38  warmerda
    00098  * added unset field support
    00099  *
    00100  * Revision 1.10  1999/11/18 19:02:20  warmerda
    00101  * expanded tabs
    00102  *
    00103  * Revision 1.9  1999/11/04 21:05:49  warmerda
    00104  * Added the Set() method on OGRFieldDefn to set all info in one call,
    00105  * and the SetFrom() method on OGRFeature to copy the contents of one
    00106  * feature to another, even if of a different OGRFeatureDefn.
    00107  *
    00108  * Revision 1.8  1999/10/01 14:47:05  warmerda
    00109  * added full family of get/set field methods with field names
    00110  *
    00111  * Revision 1.7  1999/08/30 14:52:33  warmerda
    00112  * added support for StringList fields
    00113  *
    00114  * Revision 1.6  1999/08/26 17:38:00  warmerda
    00115  * added support for real and integer lists
    00116  *
    00117  * Revision 1.5  1999/07/27 00:47:37  warmerda
    00118  * Added FID to OGRFeature class
    00119  *
    00120  * Revision 1.4  1999/07/07 04:23:07  danmo
    00121  * Fixed typo in  #define _OGR_..._H_INCLUDED  line
    00122  *
    00123  * Revision 1.3  1999/07/05 17:18:39  warmerda
    00124  * added docs
    00125  *
    00126  * Revision 1.2  1999/06/11 19:21:27  warmerda
    00127  * Fleshed out operational definitions
    00128  *
    00129  * Revision 1.1  1999/05/31 17:14:53  warmerda
    00130  * New
    00131  *
    00132  */
    00133
    00134 #ifndef _OGR_FEATURE_H_INCLUDED
    00135 #define _OGR_FEATURE_H_INCLUDED
    00136
    00137 #include "ogr_geometry.h"
    00138
    00139 class OGRStyleTable;
    00140
    00147 /************************************************************************/
    00148 /*                             OGRFieldDefn                             */
    00149 /************************************************************************/
    00150
    00155 class CPL_DLL OGRFieldDefn
    00156 {
    00157   private:
    00158     char                *pszName;
    00159     OGRFieldType        eType;
    00160     OGRJustification    eJustify;
    00161     int                 nWidth;                 /* zero is variable */
    00162     int                 nPrecision;
    00163     OGRField            uDefault;
    00164
    00165     void                Initialize( const char *, OGRFieldType );
    00166
    00167   public:
    00168                         OGRFieldDefn( const char *, OGRFieldType );
    00169                         OGRFieldDefn( OGRFieldDefn * );
    00170                         ~OGRFieldDefn();
    00171
    00172     void                SetName( const char * );
    00173     const char         *GetNameRef() { return pszName; }
    00174
    00175     OGRFieldType        GetType() { return eType; }
    00176     void                SetType( OGRFieldType eTypeIn ) { eType = eTypeIn;}
    00177     static const char  *GetFieldTypeName( OGRFieldType );
    00178
    00179     OGRJustification    GetJustify() { return eJustify; }
    00180     void                SetJustify( OGRJustification eJustifyIn )
    00181                                                 { eJustify = eJustifyIn; }
    00182
    00183     int                 GetWidth() { return nWidth; }
    00184     void                SetWidth( int nWidthIn ) { nWidth = MAX(0,nWidthIn); }
    00185
    00186     int                 GetPrecision() { return nPrecision; }
    00187     void                SetPrecision( int nPrecisionIn )
    00188                                                 { nPrecision = nPrecisionIn; }
    00189
    00190     void                Set( const char *, OGRFieldType, int = 0, int = 0,
    00191                              OGRJustification = OJUndefined );
    00192
    00193     void                SetDefault( const OGRField * );
    00194     const OGRField     *GetDefaultRef() { return &uDefault; }
    00195 };
    00196
    00197 /************************************************************************/
    00198 /*                            OGRFeatureDefn                            */
    00199 /************************************************************************/
    00200
    00217 class CPL_DLL OGRFeatureDefn
    00218 {
    00219   private:
    00220     int         nRefCount;
    00221
    00222     int         nFieldCount;
    00223     OGRFieldDefn **papoFieldDefn;
    00224
    00225     OGRwkbGeometryType eGeomType;
    00226
    00227     char        *pszFeatureClassName;
    00228
    00229   public:
    00230                 OGRFeatureDefn( const char * pszName = NULL );
    00231     virtual    ~OGRFeatureDefn();
    00232
    00233     const char  *GetName() { return pszFeatureClassName; }
    00234
    00235     int         GetFieldCount() { return nFieldCount; }
    00236     OGRFieldDefn *GetFieldDefn( int i );
    00237     int         GetFieldIndex( const char * );
    00238
    00239     void        AddFieldDefn( OGRFieldDefn * );
    00240
    00241     OGRwkbGeometryType GetGeomType() { return eGeomType; }
    00242     void        SetGeomType( OGRwkbGeometryType );
    00243
    00244     OGRFeatureDefn *Clone();
    00245
    00246     int         Reference() { return ++nRefCount; }
    00247     int         Dereference() { return --nRefCount; }
    00248     int         GetReferenceCount() { return nRefCount; }
    00249     void        Release();
    00250
    00251     static OGRFeatureDefn  *CreateFeatureDefn( const char *pszName = NULL );
    00252     static void         DestroyFeatureDefn( OGRFeatureDefn * );
    00253 };
    00254
    00255 /************************************************************************/
    00256 /*                              OGRFeature                              */
    00257 /************************************************************************/
    00258
    00263 class CPL_DLL OGRFeature
    00264 {
    00265   private:
    00266
    00267     long                nFID;
    00268     OGRFeatureDefn      *poDefn;
    00269     OGRGeometry         *poGeometry;
    00270     OGRField            *pauFields;
    00271
    00272   protected:
    00273     char *              m_pszStyleString;
    00274     OGRStyleTable       *m_poStyleTable;
    00275
    00276
    00277   public:
    00278                         OGRFeature( OGRFeatureDefn * );
    00279     virtual            ~OGRFeature();
    00280
    00281     OGRFeatureDefn     *GetDefnRef() { return poDefn; }
    00282
    00283     OGRErr              SetGeometryDirectly( OGRGeometry * );
    00284     OGRErr              SetGeometry( OGRGeometry * );
    00285     OGRGeometry        *GetGeometryRef() { return poGeometry; }
    00286     OGRGeometry        *StealGeometry();
    00287
    00288     OGRFeature         *Clone();
    00289     virtual OGRBoolean  Equal( OGRFeature * poFeature );
    00290
    00291     int                 GetFieldCount() { return poDefn->GetFieldCount(); }
    00292     OGRFieldDefn       *GetFieldDefnRef( int iField )
    00293                                       { return poDefn->GetFieldDefn(iField); }
    00294     int                 GetFieldIndex( const char * pszName)
    00295                                       { return poDefn->GetFieldIndex(pszName);}
    00296
    00297     int                 IsFieldSet( int iField )
    00298                         { return
    00299                               pauFields[iField].Set.nMarker1 != OGRUnsetMarker
    00300                            || pauFields[iField].Set.nMarker2 != OGRUnsetMarker;
    00301                               }
    00302
    00303     void                UnsetField( int iField );
    00304
    00305     OGRField           *GetRawFieldRef( int i ) { return pauFields + i; }
    00306
    00307     int                 GetFieldAsInteger( int i );
    00308     double              GetFieldAsDouble( int i );
    00309     const char         *GetFieldAsString( int i );
    00310     const int          *GetFieldAsIntegerList( int i, int *pnCount );
    00311     const double       *GetFieldAsDoubleList( int i, int *pnCount );
    00312     char              **GetFieldAsStringList( int i );
    00313     GByte              *GetFieldAsBinary( int i, int *pnCount );
    00314     int                 GetFieldAsDateTime( int i,
    00315                                      int *pnYear, int *pnMonth, int *pnDay,
    00316                                      int *pnHour, int *pnMinute, int *pnSecond,
    00317                                      int *pnTZFlag );
    00318
    00319     int                 GetFieldAsInteger( const char *pszFName )
    00320                       { return GetFieldAsInteger( GetFieldIndex(pszFName) ); }
    00321     double              GetFieldAsDouble( const char *pszFName )
    00322                       { return GetFieldAsDouble( GetFieldIndex(pszFName) ); }
    00323     const char         *GetFieldAsString( const char *pszFName )
    00324                       { return GetFieldAsString( GetFieldIndex(pszFName) ); }
    00325     const int          *GetFieldAsIntegerList( const char *pszFName,
    00326                                                int *pnCount )
    00327                       { return GetFieldAsIntegerList( GetFieldIndex(pszFName),
    00328                                                       pnCount ); }
    00329     const double       *GetFieldAsDoubleList( const char *pszFName,
    00330                                               int *pnCount )
    00331                       { return GetFieldAsDoubleList( GetFieldIndex(pszFName),
    00332                                                      pnCount ); }
    00333     char              **GetFieldAsStringList( const char *pszFName )
    00334                       { return GetFieldAsStringList(GetFieldIndex(pszFName)); }
    00335
    00336     void                SetField( int i, int nValue );
    00337     void                SetField( int i, double dfValue );
    00338     void                SetField( int i, const char * pszValue );
    00339     void                SetField( int i, int nCount, int * panValues );
    00340     void                SetField( int i, int nCount, double * padfValues );
    00341     void                SetField( int i, char ** papszValues );
    00342     void                SetField( int i, OGRField * puValue );
    00343     void                SetField( int i, int nCount, GByte * pabyBinary );
    00344     void                SetField( int i, int nYear, int nMonth, int nDay,
    00345                                   int nHour=0, int nMinute=0, int nSecond=0,
    00346                                   int nTZFlag = 0 );
    00347
    00348     void                SetField( const char *pszFName, int nValue )
    00349                            { SetField( GetFieldIndex(pszFName), nValue ); }
    00350     void                SetField( const char *pszFName, double dfValue )
    00351                            { SetField( GetFieldIndex(pszFName), dfValue ); }
    00352     void                SetField( const char *pszFName, const char * pszValue)
    00353                            { SetField( GetFieldIndex(pszFName), pszValue ); }
    00354     void                SetField( const char *pszFName, int nCount,
    00355                                   int * panValues )
    00356                          { SetField(GetFieldIndex(pszFName),nCount,panValues);}
    00357     void                SetField( const char *pszFName, int nCount,
    00358                                   double * padfValues )
    00359                          {SetField(GetFieldIndex(pszFName),nCount,padfValues);}
    00360     void                SetField( const char *pszFName, char ** papszValues )
    00361                            { SetField( GetFieldIndex(pszFName), papszValues); }
    00362     void                SetField( const char *pszFName, OGRField * puValue )
    00363                            { SetField( GetFieldIndex(pszFName), puValue ); }
    00364     void                SetField( const char *pszFName,
    00365                                   int nYear, int nMonth, int nDay,
    00366                                   int nHour=0, int nMinute=0, int nSecond=0,
    00367                                   int nTZFlag = 0 )
    00368                            { SetField( GetFieldIndex(pszFName),
    00369                                        nYear, nMonth, nDay,
    00370                                        nHour, nMinute, nSecond, nTZFlag ); }
    00371
    00372     long                GetFID() { return nFID; }
    00373     virtual OGRErr      SetFID( long nFID );
    00374
    00375     void                DumpReadable( FILE * );
    00376
    00377     OGRErr              SetFrom( OGRFeature *, int = TRUE);
    00378
    00379     OGRErr              RemapFields( OGRFeatureDefn *poNewDefn,
    00380                                      int *panRemapSource );
    00381
    00382     virtual const char *GetStyleString();
    00383     virtual void        SetStyleString(const char *);
    00384     virtual void        SetStyleTable(OGRStyleTable *poStyleTable);
    00385
    00386     static OGRFeature  *CreateFeature( OGRFeatureDefn * );
    00387     static void         DestroyFeature( OGRFeature * );
    00388 };
    00389
    00390 /************************************************************************/
    00391 /*                           OGRFeatureQuery                            */
    00392 /************************************************************************/
    00393
    00394 class OGRLayer;
    00395
    00396 class CPL_DLL OGRFeatureQuery
    00397 {
    00398   private:
    00399     OGRFeatureDefn *poTargetDefn;
    00400     void           *pSWQExpr;
    00401
    00402     char          **FieldCollector( void *, char ** );
    00403
    00404   public:
    00405                 OGRFeatureQuery();
    00406                 ~OGRFeatureQuery();
    00407
    00408     OGRErr      Compile( OGRFeatureDefn *, const char * );
    00409     int         Evaluate( OGRFeature * );
    00410
    00411     long       *EvaluateAgainstIndices( OGRLayer *, OGRErr * );
    00412
    00413     char      **GetUsedFields();
    00414
    00415     void       *GetSWGExpr() { return pSWQExpr; }
    00416 };
    00417
    00418 #endif /* ndef _OGR_FEATURE_H_INCLUDED */

Generated for GDAL by 1.4.5.