Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

ogr_feature.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  * $Id: ogr_feature.h,v 1.28 2003/05/28 19:16:42 warmerda Exp $
00003  *
00004  * Project:  OpenGIS Simple Features Reference Implementation
00005  * Purpose:  Class for representing a whole feature, and layer schemas.
00006  * Author:   Frank Warmerdam, warmerda@home.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.28  2003/05/28 19:16:42  warmerda
00032  * fixed up argument names and stuff for docs
00033  *
00034  * Revision 1.27  2003/04/08 20:57:28  warmerda
00035  * added RemapFields on OGRFeature
00036  *
00037  * Revision 1.26  2003/03/04 05:46:31  warmerda
00038  * added EvaluateAgainstIndices for OGRFeatureQuery
00039  *
00040  * Revision 1.25  2003/01/08 22:03:44  warmerda
00041  * added StealGeometry() method on OGRFeature
00042  *
00043  * Revision 1.24  2002/10/09 14:31:06  warmerda
00044  * dont permit negative widths to be assigned to field definition
00045  *
00046  * Revision 1.23  2002/09/26 18:13:17  warmerda
00047  * moved some defs to ogr_core.h for sharing with ogr_api.h
00048  *
00049  * Revision 1.22  2002/08/07 21:37:47  warmerda
00050  * added indirect OGRFeaturedefn constructor/destructor
00051  *
00052  * Revision 1.21  2001/11/01 16:54:16  warmerda
00053  * added DestroyFeature
00054  *
00055  * Revision 1.20  2001/07/19 18:25:07  warmerda
00056  * expanded tabs
00057  *
00058  * Revision 1.19  2001/06/19 15:48:36  warmerda
00059  * added feature attribute query support
00060  *
00061  * Revision 1.18  2001/06/01 14:33:00  warmerda
00062  * added CreateFeature factory method
00063  *
00064  * Revision 1.17  2001/02/06 17:10:28  warmerda
00065  * export entry points from DLL
00066  *
00067  * Revision 1.16  2001/01/19 21:10:47  warmerda
00068  * replaced tabs
00069  *
00070  * Revision 1.15  2000/12/07 03:40:13  danmo
00071  * Removed stray comma in OGRFieldType enum defn
00072  *
00073  * Revision 1.14  2000/10/03 19:19:56  danmo
00074  * Made m_pszStyleString protected (was private)
00075  *
00076  * Revision 1.13  2000/10/03 18:14:29  danmo
00077  * Made OGRFeature::Get/SetStyleString() virtual
00078  *
00079  * Revision 1.12  2000/08/18 21:26:53  svillene
00080  * Add representation
00081  *
00082  * Revision 1.11  1999/11/26 03:05:38  warmerda
00083  * added unset field support
00084  *
00085  * Revision 1.10  1999/11/18 19:02:20  warmerda
00086  * expanded tabs
00087  *
00088  * Revision 1.9  1999/11/04 21:05:49  warmerda
00089  * Added the Set() method on OGRFieldDefn to set all info in one call,
00090  * and the SetFrom() method on OGRFeature to copy the contents of one
00091  * feature to another, even if of a different OGRFeatureDefn.
00092  *
00093  * Revision 1.8  1999/10/01 14:47:05  warmerda
00094  * added full family of get/set field methods with field names
00095  *
00096  * Revision 1.7  1999/08/30 14:52:33  warmerda
00097  * added support for StringList fields
00098  *
00099  * Revision 1.6  1999/08/26 17:38:00  warmerda
00100  * added support for real and integer lists
00101  *
00102  * Revision 1.5  1999/07/27 00:47:37  warmerda
00103  * Added FID to OGRFeature class
00104  *
00105  * Revision 1.4  1999/07/07 04:23:07  danmo
00106  * Fixed typo in  #define _OGR_..._H_INCLUDED  line
00107  *
00108  * Revision 1.3  1999/07/05 17:18:39  warmerda
00109  * added docs
00110  *
00111  * Revision 1.2  1999/06/11 19:21:27  warmerda
00112  * Fleshed out operational definitions
00113  *
00114  * Revision 1.1  1999/05/31 17:14:53  warmerda
00115  * New
00116  *
00117  */
00118 
00119 #ifndef _OGR_FEATURE_H_INCLUDED
00120 #define _OGR_FEATURE_H_INCLUDED
00121 
00122 #include "ogr_geometry.h"
00123 
00124 class OGRStyleTable;
00125 
00132 /************************************************************************/
00133 /*                             OGRFieldDefn                             */
00134 /************************************************************************/
00135 
00140 class CPL_DLL OGRFieldDefn
00141 {
00142   private:
00143     char                *pszName;
00144     OGRFieldType        eType;                  
00145     OGRJustification    eJustify;               
00146     int                 nWidth;                 /* zero is variable */
00147     int                 nPrecision;
00148     OGRField            uDefault;
00149 
00150     void                Initialize( const char *, OGRFieldType );
00151     
00152   public:
00153                         OGRFieldDefn( const char *, OGRFieldType );
00154                         OGRFieldDefn( OGRFieldDefn * );
00155                         ~OGRFieldDefn();
00156 
00157     void                SetName( const char * );
00158     const char         *GetNameRef() { return pszName; }
00159 
00160     OGRFieldType        GetType() { return eType; }
00161     void                SetType( OGRFieldType eTypeIn ) { eType = eTypeIn;}
00162     static const char  *GetFieldTypeName( OGRFieldType );
00163 
00164     OGRJustification    GetJustify() { return eJustify; }
00165     void                SetJustify( OGRJustification eJustifyIn )
00166                                                 { eJustify = eJustifyIn; }
00167 
00168     int                 GetWidth() { return nWidth; }
00169     void                SetWidth( int nWidthIn ) { nWidth = MAX(0,nWidthIn); }
00170 
00171     int                 GetPrecision() { return nPrecision; }
00172     void                SetPrecision( int nPrecisionIn )
00173                                                 { nPrecision = nPrecisionIn; }
00174 
00175     void                Set( const char *, OGRFieldType, int = 0, int = 0,
00176                              OGRJustification = OJUndefined );
00177 
00178     void                SetDefault( const OGRField * );
00179     const OGRField     *GetDefaultRef() { return &uDefault; }
00180 };
00181 
00182 /************************************************************************/
00183 /*                            OGRFeatureDefn                            */
00184 /************************************************************************/
00185 
00202 class CPL_DLL OGRFeatureDefn
00203 {
00204   private:
00205     int         nRefCount;
00206     
00207     int         nFieldCount;
00208     OGRFieldDefn **papoFieldDefn;
00209 
00210     OGRwkbGeometryType eGeomType;
00211 
00212     char        *pszFeatureClassName;
00213     
00214   public:
00215                 OGRFeatureDefn( const char * pszName = NULL );
00216     virtual    ~OGRFeatureDefn();
00217 
00218     const char  *GetName() { return pszFeatureClassName; }
00219 
00220     int         GetFieldCount() { return nFieldCount; }
00221     OGRFieldDefn *GetFieldDefn( int i );
00222     int         GetFieldIndex( const char * );
00223 
00224     void        AddFieldDefn( OGRFieldDefn * );
00225 
00226     OGRwkbGeometryType GetGeomType() { return eGeomType; }
00227     void        SetGeomType( OGRwkbGeometryType );
00228 
00229     OGRFeatureDefn *Clone();
00230 
00231     int         Reference() { return ++nRefCount; }
00232     int         Dereference() { return --nRefCount; }
00233     int         GetReferenceCount() { return nRefCount; }
00234 
00235     static OGRFeatureDefn  *CreateFeatureDefn( const char *pszName = NULL );
00236     static void         DestroyFeatureDefn( OGRFeatureDefn * );
00237 };
00238 
00239 /************************************************************************/
00240 /*                              OGRFeature                              */
00241 /************************************************************************/
00242 
00247 class CPL_DLL OGRFeature
00248 {
00249   private:
00250 
00251     long                nFID;
00252     OGRFeatureDefn      *poDefn;
00253     OGRGeometry         *poGeometry;
00254     OGRField            *pauFields;
00255 
00256   protected: 
00257     char *              m_pszStyleString;
00258     OGRStyleTable       *m_poStyleTable;
00259     
00260     
00261   public:
00262                         OGRFeature( OGRFeatureDefn * );
00263     virtual            ~OGRFeature();                        
00264 
00265     OGRFeatureDefn     *GetDefnRef() { return poDefn; }
00266     
00267     OGRErr              SetGeometryDirectly( OGRGeometry * );
00268     OGRErr              SetGeometry( OGRGeometry * );
00269     OGRGeometry        *GetGeometryRef() { return poGeometry; }
00270     OGRGeometry        *StealGeometry();
00271 
00272     OGRFeature         *Clone();
00273     virtual OGRBoolean  Equal( OGRFeature * poFeature );
00274 
00275     int                 GetFieldCount() { return poDefn->GetFieldCount(); }
00276     OGRFieldDefn       *GetFieldDefnRef( int iField )
00277                                       { return poDefn->GetFieldDefn(iField); }
00278     int                 GetFieldIndex( const char * pszName)
00279                                       { return poDefn->GetFieldIndex(pszName);}
00280 
00281     int                 IsFieldSet( int iField )
00282                         { return
00283                               pauFields[iField].Set.nMarker1 != OGRUnsetMarker
00284                            || pauFields[iField].Set.nMarker2 != OGRUnsetMarker;
00285                               }
00286     
00287     void                UnsetField( int iField );
00288     
00289     OGRField           *GetRawFieldRef( int i ) { return pauFields + i; }
00290 
00291     int                 GetFieldAsInteger( int i );
00292     double              GetFieldAsDouble( int i );
00293     const char         *GetFieldAsString( int i );
00294     const int          *GetFieldAsIntegerList( int i, int *pnCount );
00295     const double       *GetFieldAsDoubleList( int i, int *pnCount );
00296     char              **GetFieldAsStringList( int i );
00297 
00298     int                 GetFieldAsInteger( const char *pszFName )
00299                       { return GetFieldAsInteger( GetFieldIndex(pszFName) ); }
00300     double              GetFieldAsDouble( const char *pszFName )
00301                       { return GetFieldAsDouble( GetFieldIndex(pszFName) ); }
00302     const char         *GetFieldAsString( const char *pszFName )
00303                       { return GetFieldAsString( GetFieldIndex(pszFName) ); }
00304     const int          *GetFieldAsIntegerList( const char *pszFName,
00305                                                int *pnCount )
00306                       { return GetFieldAsIntegerList( GetFieldIndex(pszFName),
00307                                                       pnCount ); }
00308     const double       *GetFieldAsDoubleList( const char *pszFName,
00309                                               int *pnCount )
00310                       { return GetFieldAsDoubleList( GetFieldIndex(pszFName),
00311                                                      pnCount ); }
00312     char              **GetFieldAsStringList( const char *pszFName )
00313                       { return GetFieldAsStringList(GetFieldIndex(pszFName)); }
00314 
00315     void                SetField( int i, int nValue );
00316     void                SetField( int i, double dfValue );
00317     void                SetField( int i, const char * pszValue );
00318     void                SetField( int i, int nCount, int * panValues );
00319     void                SetField( int i, int nCount, double * padfValues );
00320     void                SetField( int i, char ** papszValues );
00321     void                SetField( int i, OGRField * puValue );
00322 
00323     void                SetField( const char *pszFName, int nValue )
00324                            { SetField( GetFieldIndex(pszFName), nValue ); }
00325     void                SetField( const char *pszFName, double dfValue )
00326                            { SetField( GetFieldIndex(pszFName), dfValue ); }
00327     void                SetField( const char *pszFName, const char * pszValue)
00328                            { SetField( GetFieldIndex(pszFName), pszValue ); }
00329     void                SetField( const char *pszFName, int nCount,
00330                                   int * panValues )
00331                          { SetField(GetFieldIndex(pszFName),nCount,panValues);}
00332     void                SetField( const char *pszFName, int nCount,
00333                                   double * padfValues )
00334                          {SetField(GetFieldIndex(pszFName),nCount,padfValues);}
00335     void                SetField( const char *pszFName, char ** papszValues )
00336                            { SetField( GetFieldIndex(pszFName), papszValues); }
00337     void                SetField( const char *pszFName, OGRField * puValue )
00338                            { SetField( GetFieldIndex(pszFName), puValue ); }
00339 
00340     long                GetFID() { return nFID; }
00341     virtual OGRErr      SetFID( long nFID );
00342 
00343     void                DumpReadable( FILE * );
00344 
00345     OGRErr              SetFrom( OGRFeature *, int = TRUE);
00346 
00347     OGRErr              RemapFields( OGRFeatureDefn *poNewDefn, 
00348                                      int *panRemapSource );
00349 
00350     virtual const char *GetStyleString();
00351     virtual void        SetStyleString(const char *);
00352     virtual void        SetStyleTable(OGRStyleTable *poStyleTable);
00353 
00354     static OGRFeature  *CreateFeature( OGRFeatureDefn * );
00355     static void         DestroyFeature( OGRFeature * );
00356 };
00357 
00358 /************************************************************************/
00359 /*                           OGRFeatureQuery                            */
00360 /************************************************************************/
00361 
00362 class OGRLayer;
00363 
00364 class CPL_DLL OGRFeatureQuery
00365 {
00366   private:
00367     OGRFeatureDefn *poTargetDefn;
00368     void           *pSWQExpr;
00369     
00370   public:
00371                 OGRFeatureQuery();
00372                 ~OGRFeatureQuery();
00373 
00374     OGRErr      Compile( OGRFeatureDefn *, const char * );
00375     int         Evaluate( OGRFeature * );
00376 
00377     long       *EvaluateAgainstIndices( OGRLayer *, OGRErr * );
00378 };
00379 
00380 #endif /* ndef _OGR_FEATURE_H_INCLUDED */

Generated on Thu Nov 13 00:06:16 2003 for OGR by doxygen 1.3.4