/usr/include/gdal/ogr_core.h is in libgdal-dev 2.2.3+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 | /******************************************************************************
* $Id: ogr_core.h 37856 2017-03-28 12:10:47Z rouault $
*
* Project: OpenGIS Simple Features Reference Implementation
* Purpose: Define some core portability services for cross-platform OGR code.
* Author: Frank Warmerdam, warmerdam@pobox.com
*
******************************************************************************
* Copyright (c) 1999, Frank Warmerdam
* Copyright (c) 2007-2014, Even Rouault <even dot rouault at mines-paris dot org>
*
* 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_CORE_H_INCLUDED
#define OGR_CORE_H_INCLUDED
#include "cpl_port.h"
#include "gdal_version.h"
/**
* \file
*
* Core portability services for cross-platform OGR code.
*/
/**
* Simple container for a bounding region.
*/
/*! @cond Doxygen_Suppress */
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && !defined(DOXYGEN_SKIP)
extern "C++"
{
#include <limits>
class CPL_DLL OGREnvelope
{
public:
OGREnvelope() : MinX(std::numeric_limits<double>::infinity()),
MaxX(-std::numeric_limits<double>::infinity()),
MinY(std::numeric_limits<double>::infinity()),
MaxY(-std::numeric_limits<double>::infinity())
{
}
OGREnvelope(const OGREnvelope& oOther) :
MinX(oOther.MinX),MaxX(oOther.MaxX), MinY(oOther.MinY), MaxY(oOther.MaxY)
{
}
double MinX;
double MaxX;
double MinY;
double MaxY;
#ifdef HAVE_GCC_DIAGNOSTIC_PUSH
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wfloat-equal"
#endif
int IsInit() const { return MinX != std::numeric_limits<double>::infinity(); }
#ifdef HAVE_GCC_DIAGNOSTIC_PUSH
#pragma GCC diagnostic pop
#endif
void Merge( OGREnvelope const& sOther ) {
MinX = MIN(MinX,sOther.MinX);
MaxX = MAX(MaxX,sOther.MaxX);
MinY = MIN(MinY,sOther.MinY);
MaxY = MAX(MaxY,sOther.MaxY);
}
void Merge( double dfX, double dfY ) {
MinX = MIN(MinX,dfX);
MaxX = MAX(MaxX,dfX);
MinY = MIN(MinY,dfY);
MaxY = MAX(MaxY,dfY);
}
void Intersect( OGREnvelope const& sOther ) {
if(Intersects(sOther))
{
if( IsInit() )
{
MinX = MAX(MinX,sOther.MinX);
MaxX = MIN(MaxX,sOther.MaxX);
MinY = MAX(MinY,sOther.MinY);
MaxY = MIN(MaxY,sOther.MaxY);
}
else
{
MinX = sOther.MinX;
MaxX = sOther.MaxX;
MinY = sOther.MinY;
MaxY = sOther.MaxY;
}
}
else
{
*this = OGREnvelope();
}
}
int Intersects(OGREnvelope const& other) const
{
return MinX <= other.MaxX && MaxX >= other.MinX &&
MinY <= other.MaxY && MaxY >= other.MinY;
}
int Contains(OGREnvelope const& other) const
{
return MinX <= other.MinX && MinY <= other.MinY &&
MaxX >= other.MaxX && MaxY >= other.MaxY;
}
};
} // extern "C++"
#else
typedef struct
{
double MinX;
double MaxX;
double MinY;
double MaxY;
} OGREnvelope;
#endif
/**
* Simple container for a bounding region in 3D.
*/
#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS) && !defined(DOXYGEN_SKIP)
extern "C++" {
class CPL_DLL OGREnvelope3D : public OGREnvelope
{
public:
OGREnvelope3D() : OGREnvelope(),
MinZ(std::numeric_limits<double>::infinity()),
MaxZ(-std::numeric_limits<double>::infinity())
{
}
OGREnvelope3D(const OGREnvelope3D& oOther) :
OGREnvelope(oOther),
MinZ(oOther.MinZ), MaxZ(oOther.MaxZ)
{
}
double MinZ;
double MaxZ;
#ifdef HAVE_GCC_DIAGNOSTIC_PUSH
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wfloat-equal"
#endif
int IsInit() const { return MinX != std::numeric_limits<double>::infinity(); }
#ifdef HAVE_GCC_DIAGNOSTIC_PUSH
#pragma GCC diagnostic pop
#endif
void Merge( OGREnvelope3D const& sOther ) {
MinX = MIN(MinX,sOther.MinX);
MaxX = MAX(MaxX,sOther.MaxX);
MinY = MIN(MinY,sOther.MinY);
MaxY = MAX(MaxY,sOther.MaxY);
MinZ = MIN(MinZ,sOther.MinZ);
MaxZ = MAX(MaxZ,sOther.MaxZ);
}
void Merge( double dfX, double dfY, double dfZ ) {
MinX = MIN(MinX,dfX);
MaxX = MAX(MaxX,dfX);
MinY = MIN(MinY,dfY);
MaxY = MAX(MaxY,dfY);
MinZ = MIN(MinZ,dfZ);
MaxZ = MAX(MaxZ,dfZ);
}
void Intersect( OGREnvelope3D const& sOther ) {
if(Intersects(sOther))
{
if( IsInit() )
{
MinX = MAX(MinX,sOther.MinX);
MaxX = MIN(MaxX,sOther.MaxX);
MinY = MAX(MinY,sOther.MinY);
MaxY = MIN(MaxY,sOther.MaxY);
MinZ = MAX(MinZ,sOther.MinZ);
MaxZ = MIN(MaxZ,sOther.MaxZ);
}
else
{
MinX = sOther.MinX;
MaxX = sOther.MaxX;
MinY = sOther.MinY;
MaxY = sOther.MaxY;
MinZ = sOther.MinZ;
MaxZ = sOther.MaxZ;
}
}
else
{
*this = OGREnvelope3D();
}
}
int Intersects(OGREnvelope3D const& other) const
{
return MinX <= other.MaxX && MaxX >= other.MinX &&
MinY <= other.MaxY && MaxY >= other.MinY &&
MinZ <= other.MaxZ && MaxZ >= other.MinZ;
}
int Contains(OGREnvelope3D const& other) const
{
return MinX <= other.MinX && MinY <= other.MinY &&
MaxX >= other.MaxX && MaxY >= other.MaxY &&
MinZ <= other.MinZ && MaxZ >= other.MaxZ;
}
};
} // extern "C++"
#else
typedef struct
{
double MinX;
double MaxX;
double MinY;
double MaxY;
double MinZ;
double MaxZ;
} OGREnvelope3D;
#endif
/*! @endcond */
CPL_C_START
/*! @cond Doxygen_Suppress */
void CPL_DLL *OGRMalloc( size_t ) CPL_WARN_DEPRECATED("Use CPLMalloc instead.");
void CPL_DLL *OGRCalloc( size_t, size_t ) CPL_WARN_DEPRECATED("Use CPLCalloc instead.");
void CPL_DLL *OGRRealloc( void *, size_t ) CPL_WARN_DEPRECATED("Use CPLRealloc instead.");
char CPL_DLL *OGRStrdup( const char * ) CPL_WARN_DEPRECATED("Use CPLStrdup instead.");
void CPL_DLL OGRFree( void * ) CPL_WARN_DEPRECATED("Use CPLFree instead.");
/*! @endcond */
#ifdef STRICT_OGRERR_TYPE
/** Type for a OGR error */
typedef enum
{
OGRERR_NONE, /**< Success */
OGRERR_NOT_ENOUGH_DATA, /**< Not enough data to deserialize */
OGRERR_NOT_ENOUGH_MEMORY, /**< Not enough memory */
OGRERR_UNSUPPORTED_GEOMETRY_TYPE, /**< Unsupported geometry type */
OGRERR_UNSUPPORTED_OPERATION, /**< Unsupported operation */
OGRERR_CORRUPT_DATA, /**< Corrupt data */
OGRERR_FAILURE, /**< Failure */
OGRERR_UNSUPPORTED_SRS, /**< Unsupported SRS */
OGRERR_INVALID_HANDLE, /**< Invalid handle */
OGRERR_NON_EXISTING_FEATURE /**< Non existing feature. Added in GDAL 2.0 */
} OGRErr;
#else
/** Type for a OGR error */
typedef int OGRErr;
#define OGRERR_NONE 0 /**< Success */
#define OGRERR_NOT_ENOUGH_DATA 1 /**< Not enough data to deserialize */
#define OGRERR_NOT_ENOUGH_MEMORY 2 /**< Not enough memory */
#define OGRERR_UNSUPPORTED_GEOMETRY_TYPE 3 /**< Unsupported geometry type */
#define OGRERR_UNSUPPORTED_OPERATION 4 /**< Unsupported operation */
#define OGRERR_CORRUPT_DATA 5 /**< Corrupt data */
#define OGRERR_FAILURE 6 /**< Failure */
#define OGRERR_UNSUPPORTED_SRS 7 /**< Unsupported SRS */
#define OGRERR_INVALID_HANDLE 8 /**< Invalid handle */
#define OGRERR_NON_EXISTING_FEATURE 9 /**< Non existing feature. Added in GDAL 2.0 */
#endif
/** Type for a OGR boolean */
typedef int OGRBoolean;
/* -------------------------------------------------------------------- */
/* ogr_geometry.h related definitions. */
/* -------------------------------------------------------------------- */
/**
* List of well known binary geometry types. These are used within the BLOBs
* but are also returned from OGRGeometry::getGeometryType() to identify the
* type of a geometry object.
*/
typedef enum
{
wkbUnknown = 0, /**< unknown type, non-standard */
wkbPoint = 1, /**< 0-dimensional geometric object, standard WKB */
wkbLineString = 2, /**< 1-dimensional geometric object with linear
* interpolation between Points, standard WKB */
wkbPolygon = 3, /**< planar 2-dimensional geometric object defined
* by 1 exterior boundary and 0 or more interior
* boundaries, standard WKB */
wkbMultiPoint = 4, /**< GeometryCollection of Points, standard WKB */
wkbMultiLineString = 5, /**< GeometryCollection of LineStrings, standard WKB */
wkbMultiPolygon = 6, /**< GeometryCollection of Polygons, standard WKB */
wkbGeometryCollection = 7, /**< geometric object that is a collection of 1
or more geometric objects, standard WKB */
wkbCircularString = 8, /**< one or more circular arc segments connected end to end,
* ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbCompoundCurve = 9, /**< sequence of contiguous curves, ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbCurvePolygon = 10, /**< planar surface, defined by 1 exterior boundary
* and zero or more interior boundaries, that are curves.
* ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbMultiCurve = 11, /**< GeometryCollection of Curves, ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbMultiSurface = 12, /**< GeometryCollection of Surfaces, ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbCurve = 13, /**< Curve (abstract type). ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbSurface = 14, /**< Surface (abstract type). ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbPolyhedralSurface = 15,/**< a contiguous collection of polygons, which share common boundary segments,
* ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTIN = 16, /**< a PolyhedralSurface consisting only of Triangle patches
* ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTriangle = 17, /**< a Triangle. ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbNone = 100, /**< non-standard, for pure attribute records */
wkbLinearRing = 101, /**< non-standard, just for createGeometry() */
wkbCircularStringZ = 1008, /**< wkbCircularString with Z component. ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbCompoundCurveZ = 1009, /**< wkbCompoundCurve with Z component. ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbCurvePolygonZ = 1010, /**< wkbCurvePolygon with Z component. ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbMultiCurveZ = 1011, /**< wkbMultiCurve with Z component. ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbMultiSurfaceZ = 1012, /**< wkbMultiSurface with Z component. ISO SQL/MM Part 3. GDAL >= 2.0 */
wkbCurveZ = 1013, /**< wkbCurve with Z component. ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbSurfaceZ = 1014, /**< wkbSurface with Z component. ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbPolyhedralSurfaceZ = 1015, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTINZ = 1016, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTriangleZ = 1017, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbPointM = 2001, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbLineStringM = 2002, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbPolygonM = 2003, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiPointM = 2004, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiLineStringM = 2005, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiPolygonM = 2006, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbGeometryCollectionM = 2007, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCircularStringM = 2008, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCompoundCurveM = 2009, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCurvePolygonM = 2010, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiCurveM = 2011, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiSurfaceM = 2012, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCurveM = 2013, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbSurfaceM = 2014, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbPolyhedralSurfaceM = 2015, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTINM = 2016, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTriangleM = 2017, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbPointZM = 3001, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbLineStringZM = 3002, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbPolygonZM = 3003, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiPointZM = 3004, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiLineStringZM = 3005, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiPolygonZM = 3006, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbGeometryCollectionZM = 3007, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCircularStringZM = 3008, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCompoundCurveZM = 3009, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCurvePolygonZM = 3010, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiCurveZM = 3011, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbMultiSurfaceZM = 3012, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbCurveZM = 3013, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbSurfaceZM = 3014, /**< ISO SQL/MM Part 3. GDAL >= 2.1 */
wkbPolyhedralSurfaceZM = 3015, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTINZM = 3016, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbTriangleZM = 3017, /**< ISO SQL/MM Part 3. Reserved in GDAL >= 2.1 but not yet implemented */
wkbPoint25D = 0x80000001, /**< 2.5D extension as per 99-402 */
wkbLineString25D = 0x80000002, /**< 2.5D extension as per 99-402 */
wkbPolygon25D = 0x80000003, /**< 2.5D extension as per 99-402 */
wkbMultiPoint25D = 0x80000004, /**< 2.5D extension as per 99-402 */
wkbMultiLineString25D = 0x80000005, /**< 2.5D extension as per 99-402 */
wkbMultiPolygon25D = 0x80000006, /**< 2.5D extension as per 99-402 */
wkbGeometryCollection25D = 0x80000007 /**< 2.5D extension as per 99-402 */
} OGRwkbGeometryType;
/**
* Output variants of WKB we support.
*
* 99-402 was a short-lived extension to SFSQL 1.1 that used a high-bit flag
* to indicate the presence of Z coordinates in a WKB geometry.
*
* SQL/MM Part 3 and SFSQL 1.2 use offsets of 1000 (Z), 2000 (M) and 3000 (ZM)
* to indicate the present of higher dimensional coordinates in a WKB geometry.
* Reference: <a href="https://portal.opengeospatial.org/files/?artifact_id=320243">
* 09-009_Committee_Draft_ISOIEC_CD_13249-3_SQLMM_Spatial.pdf</a>,
* ISO/IEC JTC 1/SC 32 N 1820, ISO/IEC CD 13249-3:201x(E), Date: 2009-01-16.
* The codes are also found in §8.2.3 of <a href="http://portal.opengeospatial.org/files/?artifact_id=25355">
* OGC 06-103r4 "OpenGIS® Implementation Standard for Geographic information - Simple feature access - Part 1: Common architecture", v1.2.1</a>
*/
typedef enum
{
wkbVariantOldOgc, /**< Old-style 99-402 extended dimension (Z) WKB types */
wkbVariantIso, /**< SFSQL 1.2 and ISO SQL/MM Part 3 extended dimension (Z&M) WKB types */
wkbVariantPostGIS1 /**< PostGIS 1.X has different codes for CurvePolygon, MultiCurve and MultiSurface */
} OGRwkbVariant;
#ifndef GDAL_COMPILATION
/** @deprecated in GDAL 2.0. Use wkbHasZ() or wkbSetZ() instead */
#define wkb25DBit 0x80000000
#endif
/** Return the 2D geometry type corresponding to the specified geometry type */
#define wkbFlatten(x) OGR_GT_Flatten((OGRwkbGeometryType)(x))
/** Return if the geometry type is a 3D geometry type
* @since GDAL 2.0
*/
#define wkbHasZ(x) (OGR_GT_HasZ(x) != 0)
/** Return the 3D geometry type corresponding to the specified geometry type.
* @since GDAL 2.0
*/
#define wkbSetZ(x) OGR_GT_SetZ(x)
/** Return if the geometry type is a measured geometry type
* @since GDAL 2.1
*/
#define wkbHasM(x) (OGR_GT_HasM(x) != 0)
/** Return the measured geometry type corresponding to the specified geometry type.
* @since GDAL 2.1
*/
#define wkbSetM(x) OGR_GT_SetM(x)
#ifndef DOXYGEN_SKIP
#define ogrZMarker 0x21125711
#endif
const char CPL_DLL * OGRGeometryTypeToName( OGRwkbGeometryType eType );
OGRwkbGeometryType CPL_DLL OGRMergeGeometryTypes( OGRwkbGeometryType eMain,
OGRwkbGeometryType eExtra );
OGRwkbGeometryType CPL_DLL OGRMergeGeometryTypesEx( OGRwkbGeometryType eMain,
OGRwkbGeometryType eExtra,
int bAllowPromotingToCurves );
OGRwkbGeometryType CPL_DLL OGR_GT_Flatten( OGRwkbGeometryType eType );
OGRwkbGeometryType CPL_DLL OGR_GT_SetZ( OGRwkbGeometryType eType );
OGRwkbGeometryType CPL_DLL OGR_GT_SetM( OGRwkbGeometryType eType );
OGRwkbGeometryType CPL_DLL OGR_GT_SetModifier( OGRwkbGeometryType eType, int bSetZ, int bSetM );
int CPL_DLL OGR_GT_HasZ( OGRwkbGeometryType eType );
int CPL_DLL OGR_GT_HasM( OGRwkbGeometryType eType );
int CPL_DLL OGR_GT_IsSubClassOf( OGRwkbGeometryType eType,
OGRwkbGeometryType eSuperType );
int CPL_DLL OGR_GT_IsCurve( OGRwkbGeometryType );
int CPL_DLL OGR_GT_IsSurface( OGRwkbGeometryType );
int CPL_DLL OGR_GT_IsNonLinear( OGRwkbGeometryType );
OGRwkbGeometryType CPL_DLL OGR_GT_GetCollection( OGRwkbGeometryType eType );
OGRwkbGeometryType CPL_DLL OGR_GT_GetCurve( OGRwkbGeometryType eType );
OGRwkbGeometryType CPL_DLL OGR_GT_GetLinear( OGRwkbGeometryType eType );
/** Enumeration to describe byte order */
typedef enum
{
wkbXDR = 0, /**< MSB/Sun/Motoroloa: Most Significant Byte First */
wkbNDR = 1 /**< LSB/Intel/Vax: Least Significant Byte First */
} OGRwkbByteOrder;
#ifndef DOXYGEN_SKIP
#ifndef NO_HACK_FOR_IBM_DB2_V72
# define HACK_FOR_IBM_DB2_V72
#endif
#ifdef HACK_FOR_IBM_DB2_V72
# define DB2_V72_FIX_BYTE_ORDER(x) ((((x) & 0x31) == (x)) ? ((x) & 0x1) : (x))
# define DB2_V72_UNFIX_BYTE_ORDER(x) ((unsigned char) (OGRGeometry::bGenerate_DB2_V72_BYTE_ORDER ? ((x) | 0x30) : (x)))
#else
# define DB2_V72_FIX_BYTE_ORDER(x) (x)
# define DB2_V72_UNFIX_BYTE_ORDER(x) (x)
#endif
#endif /* #ifndef DOXYGEN_SKIP */
/** Alter field name.
* Used by OGR_L_AlterFieldDefn().
*/
#define ALTER_NAME_FLAG 0x1
/** Alter field type.
* Used by OGR_L_AlterFieldDefn().
*/
#define ALTER_TYPE_FLAG 0x2
/** Alter field width and precision.
* Used by OGR_L_AlterFieldDefn().
*/
#define ALTER_WIDTH_PRECISION_FLAG 0x4
/** Alter field NOT NULL constraint.
* Used by OGR_L_AlterFieldDefn().
* @since GDAL 2.0
*/
#define ALTER_NULLABLE_FLAG 0x8
/** Alter field DEFAULT value.
* Used by OGR_L_AlterFieldDefn().
* @since GDAL 2.0
*/
#define ALTER_DEFAULT_FLAG 0x10
/** Alter all parameters of field definition.
* Used by OGR_L_AlterFieldDefn().
*/
#define ALTER_ALL_FLAG (ALTER_NAME_FLAG | ALTER_TYPE_FLAG | ALTER_WIDTH_PRECISION_FLAG | ALTER_NULLABLE_FLAG | ALTER_DEFAULT_FLAG)
/** Validate that fields respect not-null constraints.
* Used by OGR_F_Validate().
* @since GDAL 2.0
*/
#define OGR_F_VAL_NULL 0x00000001
/** Validate that geometries respect geometry column type.
* Used by OGR_F_Validate().
* @since GDAL 2.0
*/
#define OGR_F_VAL_GEOM_TYPE 0x00000002
/** Validate that (string) fields respect field width.
* Used by OGR_F_Validate().
* @since GDAL 2.0
*/
#define OGR_F_VAL_WIDTH 0x00000004
/** Allow fields that are null when there's an associated default value.
* This can be used for drivers where the low-level layers will automatically set the
* field value to the associated default value.
* This flag only makes sense if OGR_F_VAL_NULL is set too.
* Used by OGR_F_Validate().
* @since GDAL 2.0
*/
#define OGR_F_VAL_ALLOW_NULL_WHEN_DEFAULT 0x00000008
/** Allow geometry fields to have a different coordinate dimension that their
* geometry column type.
* This flag only makes sense if OGR_F_VAL_GEOM_TYPE is set too.
* Used by OGR_F_Validate().
* @since GDAL 2.1
*/
#define OGR_F_VAL_ALLOW_DIFFERENT_GEOM_DIM 0x00000010
/** Enable all validation tests (except OGR_F_VAL_ALLOW_DIFFERENT_GEOM_DIM)
* Used by OGR_F_Validate().
* @since GDAL 2.0
*/
#define OGR_F_VAL_ALL (0x7FFFFFFF & ~OGR_F_VAL_ALLOW_DIFFERENT_GEOM_DIM)
/************************************************************************/
/* ogr_feature.h related definitions. */
/************************************************************************/
/**
* List of feature field types. This list is likely to be extended in the
* future ... avoid coding applications based on the assumption that all
* field types can be known.
*/
typedef enum
{
/** Simple 32bit integer */ OFTInteger = 0,
/** List of 32bit integers */ OFTIntegerList = 1,
/** Double Precision floating point */ OFTReal = 2,
/** List of doubles */ OFTRealList = 3,
/** String of ASCII chars */ OFTString = 4,
/** Array of strings */ OFTStringList = 5,
/** deprecated */ OFTWideString = 6,
/** deprecated */ OFTWideStringList = 7,
/** Raw Binary data */ OFTBinary = 8,
/** Date */ OFTDate = 9,
/** Time */ OFTTime = 10,
/** Date and Time */ OFTDateTime = 11,
/** Single 64bit integer */ OFTInteger64 = 12,
/** List of 64bit integers */ OFTInteger64List = 13,
OFTMaxType = 13
} OGRFieldType;
/**
* List of field subtypes. A subtype represents a hint, a restriction of the
* main type, that is not strictly necessary to consult.
* This list is likely to be extended in the
* future ... avoid coding applications based on the assumption that all
* field types can be known.
* Most subtypes only make sense for a restricted set of main types.
* @since GDAL 2.0
*/
typedef enum
{
/** No subtype. This is the default value */ OFSTNone = 0,
/** Boolean integer. Only valid for OFTInteger and OFTIntegerList.*/
OFSTBoolean = 1,
/** Signed 16-bit integer. Only valid for OFTInteger and OFTIntegerList. */
OFSTInt16 = 2,
/** Single precision (32 bit) floating point. Only valid for OFTReal and OFTRealList. */
OFSTFloat32 = 3,
OFSTMaxSubType = 3
} OGRFieldSubType;
/**
* Display justification for field values.
*/
typedef enum
{
OJUndefined = 0,
OJLeft = 1,
OJRight = 2
} OGRJustification;
/** Special value for a unset FID */
#define OGRNullFID -1
/** Special value set in OGRField.Set.nMarker1, nMarker2 and nMarker3 for
* a unset field.
* Direct use of this value is strongly discouraged.
* Use OGR_RawField_SetUnset() or OGR_RawField_IsUnset() instead.
*/
#define OGRUnsetMarker -21121
/** Special value set in OGRField.Set.nMarker1, nMarker2 and nMarker3 for
* a null field.
* Direct use of this value is strongly discouraged.
* Use OGR_RawField_SetNull() or OGR_RawField_IsNull() instead.
* @since GDAL 2.2
*/
#define OGRNullMarker -21122
/************************************************************************/
/* OGRField */
/************************************************************************/
/**
* OGRFeature field attribute value union.
*/
typedef union {
/*! @cond Doxygen_Suppress */
int Integer;
GIntBig Integer64;
double Real;
char *String;
struct {
int nCount;
int *paList;
} IntegerList;
struct {
int nCount;
GIntBig *paList;
} Integer64List;
struct {
int nCount;
double *paList;
} RealList;
struct {
int nCount;
char **paList;
} StringList;
struct {
int nCount;
GByte *paData;
} Binary;
struct {
int nMarker1;
int nMarker2;
int nMarker3;
} Set;
struct {
GInt16 Year;
GByte Month;
GByte Day;
GByte Hour;
GByte Minute;
GByte TZFlag; /* 0=unknown, 1=localtime(ambiguous),
100=GMT, 104=GMT+1, 80=GMT-5, etc */
GByte Reserved; /* must be set to 0 */
float Second; /* with millisecond accuracy. at the end of the structure, so as to keep it 12 bytes on 32 bit */
} Date;
/*! @endcond */
} OGRField;
/** Return the number of milliseconds from a datetime with decimal seconds */
#define OGR_GET_MS(floatingpoint_sec) (int)(((floatingpoint_sec) - (int)(floatingpoint_sec)) * 1000 + 0.5)
int CPL_DLL OGRParseDate( const char *pszInput, OGRField *psOutput,
int nOptions );
/* -------------------------------------------------------------------- */
/* Constants from ogrsf_frmts.h for capabilities. */
/* -------------------------------------------------------------------- */
#define OLCRandomRead "RandomRead" /**< Layer capability for random read */
#define OLCSequentialWrite "SequentialWrite" /**< Layer capability for sequential write */
#define OLCRandomWrite "RandomWrite" /**< Layer capability for random write */
#define OLCFastSpatialFilter "FastSpatialFilter" /**< Layer capability for fast spatial filter */
#define OLCFastFeatureCount "FastFeatureCount" /**< Layer capability for fast feature count retrieval */
#define OLCFastGetExtent "FastGetExtent" /**< Layer capability for fast extent retrieval */
#define OLCCreateField "CreateField" /**< Layer capability for field creation */
#define OLCDeleteField "DeleteField" /**< Layer capability for field deletion */
#define OLCReorderFields "ReorderFields" /**< Layer capability for field reordering */
#define OLCAlterFieldDefn "AlterFieldDefn" /**< Layer capability for field alteration */
#define OLCTransactions "Transactions" /**< Layer capability for transactions */
#define OLCDeleteFeature "DeleteFeature" /**< Layer capability for feature deletion */
#define OLCFastSetNextByIndex "FastSetNextByIndex" /**< Layer capability for setting next feature index */
#define OLCStringsAsUTF8 "StringsAsUTF8" /**< Layer capability for strings returned with UTF-8 encoding */
#define OLCIgnoreFields "IgnoreFields" /**< Layer capability for field ignoring */
#define OLCCreateGeomField "CreateGeomField" /**< Layer capability for geometry field creation */
#define OLCCurveGeometries "CurveGeometries" /**< Layer capability for curve geometries support */
#define OLCMeasuredGeometries "MeasuredGeometries" /**< Layer capability for measured geometries support */
#define ODsCCreateLayer "CreateLayer" /**< Dataset capability for layer creation */
#define ODsCDeleteLayer "DeleteLayer" /**< Dataset capability for layer deletion */
#define ODsCCreateGeomFieldAfterCreateLayer "CreateGeomFieldAfterCreateLayer" /**< Dataset capability for geometry field creation support */
#define ODsCCurveGeometries "CurveGeometries" /**< Dataset capability for curve geometries support */
#define ODsCTransactions "Transactions" /**< Dataset capability for dataset transcations */
#define ODsCEmulatedTransactions "EmulatedTransactions" /**< Dataset capability for emulated dataset transactions */
#define ODsCMeasuredGeometries "MeasuredGeometries" /**< Dataset capability for measured geometries support */
#define ODsCRandomLayerRead "RandomLayerRead" /**< Dataset capability for GetNextFeature() returning features from random layers */
#define ODsCRandomLayerWrite "RandomLayerWrite " /**< Dataset capability for supporting CreateFeature on layer in random order */
#define ODrCCreateDataSource "CreateDataSource" /**< Driver capability for datasource creation */
#define ODrCDeleteDataSource "DeleteDataSource" /**< Driver capability for datasource deletion */
/* -------------------------------------------------------------------- */
/* Layer metadata items. */
/* -------------------------------------------------------------------- */
/** Capability set to YES as metadata on a layer that has features with
* 64 bit identifiers.
@since GDAL 2.0
*/
#define OLMD_FID64 "OLMD_FID64"
/************************************************************************/
/* ogr_featurestyle.h related definitions. */
/************************************************************************/
/**
* OGRStyleTool derived class types (returned by GetType()).
*/
typedef enum ogr_style_tool_class_id
{
OGRSTCNone = 0, /**< None */
OGRSTCPen = 1, /**< Pen */
OGRSTCBrush = 2, /**< Brush */
OGRSTCSymbol = 3, /**< Symbol */
OGRSTCLabel = 4, /**< Label */
OGRSTCVector = 5 /**< Vector */
} OGRSTClassId;
/**
* List of units supported by OGRStyleTools.
*/
typedef enum ogr_style_tool_units_id
{
OGRSTUGround = 0, /**< Ground unit */
OGRSTUPixel = 1, /**< Pixel */
OGRSTUPoints = 2, /**< Points */
OGRSTUMM = 3, /**< Millimeter */
OGRSTUCM = 4, /**< Centimeter */
OGRSTUInches = 5 /**< Inch */
} OGRSTUnitId;
/**
* List of parameters for use with OGRStylePen.
*/
typedef enum ogr_style_tool_param_pen_id
{
OGRSTPenColor = 0, /**< Color */
OGRSTPenWidth = 1, /**< Width */
OGRSTPenPattern = 2, /**< Pattern */
OGRSTPenId = 3, /**< Id */
OGRSTPenPerOffset = 4, /**< Perpendicular offset */
OGRSTPenCap = 5, /**< Cap */
OGRSTPenJoin = 6, /**< Join */
OGRSTPenPriority = 7, /**< Priority */
#ifndef DOXYGEN_SKIP
OGRSTPenLast = 8
#endif
} OGRSTPenParam;
/**
* List of parameters for use with OGRStyleBrush.
*/
typedef enum ogr_style_tool_param_brush_id
{
OGRSTBrushFColor = 0, /**< Foreground color */
OGRSTBrushBColor = 1, /**< Background color */
OGRSTBrushId = 2, /**< Id */
OGRSTBrushAngle = 3, /**< Angle */
OGRSTBrushSize = 4, /**< Size */
OGRSTBrushDx = 5, /**< Dx */
OGRSTBrushDy = 6, /**< Dy */
OGRSTBrushPriority = 7, /**< Priority */
#ifndef DOXYGEN_SKIP
OGRSTBrushLast = 8
#endif
} OGRSTBrushParam;
/**
* List of parameters for use with OGRStyleSymbol.
*/
typedef enum ogr_style_tool_param_symbol_id
{
OGRSTSymbolId = 0, /**< Id */
OGRSTSymbolAngle = 1, /**< Angle */
OGRSTSymbolColor = 2, /**< Color */
OGRSTSymbolSize = 3, /**< Size */
OGRSTSymbolDx = 4, /**< Dx */
OGRSTSymbolDy = 5, /**< Dy */
OGRSTSymbolStep = 6, /**< Step */
OGRSTSymbolPerp = 7, /**< Perpendicular */
OGRSTSymbolOffset = 8, /**< Offset */
OGRSTSymbolPriority = 9, /**< Priority */
OGRSTSymbolFontName = 10, /**< Font name */
OGRSTSymbolOColor = 11, /**< Outline color */
#ifndef DOXYGEN_SKIP
OGRSTSymbolLast = 12
#endif
} OGRSTSymbolParam;
/**
* List of parameters for use with OGRStyleLabel.
*/
typedef enum ogr_style_tool_param_label_id
{
OGRSTLabelFontName = 0, /**< Font name */
OGRSTLabelSize = 1, /**< Size */
OGRSTLabelTextString = 2, /**< Text string */
OGRSTLabelAngle = 3, /**< Angle */
OGRSTLabelFColor = 4, /**< Foreground color */
OGRSTLabelBColor = 5, /**< Background color */
OGRSTLabelPlacement = 6, /**< Placement */
OGRSTLabelAnchor = 7, /**< Anchor */
OGRSTLabelDx = 8, /**< Dx */
OGRSTLabelDy = 9, /**< Dy */
OGRSTLabelPerp = 10, /**< Perpendicular */
OGRSTLabelBold = 11, /**< Bold */
OGRSTLabelItalic = 12, /**< Italic */
OGRSTLabelUnderline = 13, /**< Underline */
OGRSTLabelPriority = 14, /**< Priority */
OGRSTLabelStrikeout = 15, /**< Strike out */
OGRSTLabelStretch = 16, /**< Stretch */
OGRSTLabelAdjHor = 17, /**< Horizontal adjustment */
OGRSTLabelAdjVert = 18, /**< Vectical adjustment */
OGRSTLabelHColor = 19, /**< Highlight color */
OGRSTLabelOColor = 20, /**< Outline color */
#ifndef DOXYGEN_SKIP
OGRSTLabelLast = 21
#endif
} OGRSTLabelParam;
/* ------------------------------------------------------------------- */
/* Version checking */
/* -------------------------------------------------------------------- */
#ifndef DOXYGEN_SKIP
/* Note to developers : please keep this section in sync with gdal.h */
#ifndef GDAL_VERSION_INFO_DEFINED
#define GDAL_VERSION_INFO_DEFINED
const char CPL_DLL * CPL_STDCALL GDALVersionInfo( const char * );
#endif
#ifndef GDAL_CHECK_VERSION
/** Return TRUE if GDAL library version at runtime matches nVersionMajor.nVersionMinor.
The purpose of this method is to ensure that calling code will run with the GDAL
version it is compiled for. It is primarily indented for external plugins.
@param nVersionMajor Major version to be tested against
@param nVersionMinor Minor version to be tested against
@param pszCallingComponentName If not NULL, in case of version mismatch, the method
will issue a failure mentioning the name of
the calling component.
*/
int CPL_DLL CPL_STDCALL GDALCheckVersion( int nVersionMajor, int nVersionMinor,
const char* pszCallingComponentName);
/** Helper macro for GDALCheckVersion */
#define GDAL_CHECK_VERSION(pszCallingComponentName) \
GDALCheckVersion(GDAL_VERSION_MAJOR, GDAL_VERSION_MINOR, pszCallingComponentName)
#endif
#endif /* #ifndef DOXYGEN_SKIP */
CPL_C_END
#endif /* ndef OGR_CORE_H_INCLUDED */
|