/usr/include/rasterlite2/rl2wms.h is in librasterlite2-dev 1.0.0~rc0+devel1-6.
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 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 | /*
rl2wms.h -- RasterLite2 common WMS support
version 2.0, 2013 July 28
Author: Sandro Furieri a.furieri@lqt.it
------------------------------------------------------------------------------
Version: MPL 1.1/GPL 2.0/LGPL 2.1
The contents of this file are subject to the Mozilla Public License Version
1.1 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.mozilla.org/MPL/
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the
License.
The Original Code is the RasterLite2 library
The Initial Developer of the Original Code is Alessandro Furieri
Portions created by the Initial Developer are Copyright (C) 2013
the Initial Developer. All Rights Reserved.
Contributor(s):
Alternatively, the contents of this file may be used under the terms of
either the GNU General Public License Version 2 or later (the "GPL"), or
the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
in which case the provisions of the GPL or the LGPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of either the GPL or the LGPL, and not to allow others to
use your version of this file under the terms of the MPL, indicate your
decision by deleting the provisions above and replace them with the notice
and other provisions required by the GPL or the LGPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the MPL, the GPL or the LGPL.
*/
/**
\file rl2wms.h
WMS support
*/
#ifndef _RL2WMS_H
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define _RL2WMS_H
#endif
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct rl2_wms_catalog rl2WmsCatalog;
typedef rl2WmsCatalog *rl2WmsCatalogPtr;
typedef struct rl2_wms_item rl2WmsLayer;
typedef rl2WmsLayer *rl2WmsLayerPtr;
typedef struct rl2_wms_tiled_item rl2WmsTiledLayer;
typedef rl2WmsTiledLayer *rl2WmsTiledLayerPtr;
typedef struct rl2_wms_tile_pattern rl2WmsTilePattern;
typedef rl2WmsTilePattern *rl2WmsTilePatternPtr;
typedef struct rl2_wms_feature_collection rl2WmsFeatureCollection;
typedef rl2WmsFeatureCollection *rl2WmsFeatureCollectionPtr;
typedef struct rl2_wms_feature_member rl2WmsFeatureMember;
typedef rl2WmsFeatureMember *rl2WmsFeatureMemberPtr;
typedef struct rl2_wms_cache rl2WmsCache;
typedef struct rl2_wms_cache *rl2WmsCachePtr;
/**
Creates a Catalog for some WMS service
\param cache_handle handle to local WMS cache
\param url pointer to some WMS-GetCapabilities XML Document.
\param proxy pointer to some HTTP PROXY: may be NULL.
\param err_msg on completion will contain an error message (if any)
\return the pointer to the corresponding WMS-Catalog object: NULL on failure
\sa destroy_wms_catalog, get_wms_version, get_wms_name, get_wms_title, get_wms_abstract,
is_wms_tile_service, get_wms_catalog_count, get_wms_catalog_layer
\note an eventual error message returned via err_msg requires to be deallocated
by invoking free().\n
you are responsible to destroy (before or after) any WMS-Catalog returned by create_wms_catalog().
*/
RL2_DECLARE rl2WmsCatalogPtr create_wms_catalog (rl2WmsCachePtr
cache_handle,
const char *url,
const char *proxy,
char **err_msg);
/**
Destroys a WMS-Catalog object freeing any allocated resource
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\sa create_wms_catalog
*/
RL2_DECLARE void destroy_wms_catalog (rl2WmsCatalogPtr handle);
/**
Tests if a WMS-Catalog object actually corresponds to a TileService
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return 0 (false) if not, any other value if yes: a negative value on error.
\sa create_wms_catalog, get_wms_tile_service_name, get_wms_tile_service_title,
get_wms_tile_service_abstract, get_wms_tile_service_count, get_wms_catalog_tiled_layer
*/
RL2_DECLARE int is_wms_tile_service (rl2WmsCatalogPtr handle);
/**
Return the TileService name corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog (of the TileService type)
returned by a previous call to get_wms_catalog_layer().
\return the name corresponding to the WMS TileService (if any)
\sa get_wms_tile_service_title, get_wms_tile_service_abstract
*/
RL2_DECLARE const char *get_wms_tile_service_name (rl2WmsCatalogPtr handle);
/**
Return the TileService title corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog (of the TileService type)
returned by a previous call to get_wms_catalog_layer().
\return the title corresponding to the WMS TileService (if any)
\sa get_wms_tile_service_name, get_wms_tile_service_abstract
*/
RL2_DECLARE const char *get_wms_tile_service_title (rl2WmsCatalogPtr
handle);
/**
Return the TileService abstract corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog (of the TileService type)
returned by a previous call to get_wms_catalog_layer().
\return the abstract corresponding to the WMS TileService (if any)
\sa get_wms_tile_service_title, get_wms_tile_service_title
*/
RL2_DECLARE const char *get_wms_tile_service_abstract (rl2WmsCatalogPtr
handle);
/**
Return the total count of first-level Layers defined within a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the total count of first-level Layers defined within a WMS-Catalog object:
a negative number if the WMS-Catalog isn't valid
\sa create_wms_catalog, get_wms_catalog_layer, get_wms_format_count,
get_wms_tile_service_count
*/
RL2_DECLARE int get_wms_catalog_count (rl2WmsCatalogPtr handle);
/**
Return the total count of first-level Tiled Layers defined within a
WMS-Catalog [TileService] object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the total count of first-level Tiled Layers defined within a WMS-Catalog
[TileService] object:
a negative number if the WMS-Catalog isn't valid
\sa create_wms_catalog, get_wms_catalog_tiled, layer, get_wms_format_count,
get_wms_catalog_count
*/
RL2_DECLARE int get_wms_tile_service_count (rl2WmsCatalogPtr handle);
/**
Return the total count of Formats supported by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\param mode TRUE if only valid "image formats" should be considered;
if set to FALSE then any possible format will be considered.
\return the total count of Formats supported by a WMS-Catalog object:
ZERO or a a negative number if the WMS-Catalog isn't valid
\sa create_wms_catalog, get_wms_format, get_wms_catalog_count
*/
RL2_DECLARE int get_wms_format_count (rl2WmsCatalogPtr handle, int mode);
/**
Return the version string corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to get_wms_catalog_layer().
\return the version string corresponding to the WMS-Catalog object
\sa get_wms_name, get_wms_title, get_wms_abstract
*/
RL2_DECLARE const char *get_wms_version (rl2WmsCatalogPtr handle);
/**
Return the name corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to get_wms_catalog_layer().
\return the name corresponding to the WMS-Catalog object
\sa get_wms_version, get_wms_title, get_wms_abstract
*/
RL2_DECLARE const char *get_wms_name (rl2WmsCatalogPtr handle);
/**
Return the title corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to get_wms_catalog_layer().
\return the title corresponding to the WMS-Catalog object
\sa get_wms_version, get_wms_name, get_wms_abstract
*/
RL2_DECLARE const char *get_wms_title (rl2WmsCatalogPtr handle);
/**
Return the abstract corresponding to some WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to get_wms_catalog_layer().
\return the abstract corresponding to the WMS-Catalog object
\sa get_wms_version, get_wms_name, get_wms_title
*/
RL2_DECLARE const char *get_wms_abstract (rl2WmsCatalogPtr handle);
/**
Return the GetMap URL (method GET) from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the corresponding URL: NULL if the URL is not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetMap_post, get_wms_url_GetTileService_get,
get_wms_url_GetTileService_post, get_wms_url_GetFeatureInfo_get,
get_wms_url_GetFeatureInfo_post
*/
RL2_DECLARE const char *get_wms_url_GetMap_get (rl2WmsCatalogPtr handle);
/**
Return the GetMap URL (method POST) from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the corresponding URL: NULL if the URL is not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetMap_get, get_wms_url_GetTileService_get,
get_wms_url_GetTileService_post, get_wms_url_GetFeatureInfo_get,
get_wms_url_GetFeatureInfo_post
*/
RL2_DECLARE const char *get_wms_url_GetMap_post (rl2WmsCatalogPtr handle);
/**
Return the GetTileService URL (method GET) from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the corresponding URL: NULL if the URL is not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetMap_get, get_wms_url_GetMap_post,
get_wms_url_GetTileService_post, get_wms_url_GetFeatureInfo_get,
get_wms_url_GetFeatureInfo_post
*/
RL2_DECLARE const char *get_wms_url_GetTileService_get (rl2WmsCatalogPtr
handle);
/**
Return the GetTileService URL (method POST) from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the corresponding URL: NULL if the URL is not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetMap_get, get_wms_url_GetMap_post,
get_wms_url_GetTileService_get, get_wms_url_GetFeatureInfo_get,
get_wms_url_GetFeatureInfo_post
*/
RL2_DECLARE const char *get_wms_url_GetTileService_post (rl2WmsCatalogPtr
handle);
/**
Return the GetFeatureInfo URL (method GET) from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the corresponding URL: NULL if the URL is not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetMap_get, get_wms_url_GetMap_post,
get_wms_url_GetTileService_get, get_wms_url_GetTileService_post,
get_wms_url_GetFeatureInfo_post, get_wms_gml_mime_type, get_wms_xml_mime_type
*/
RL2_DECLARE const char *get_wms_url_GetFeatureInfo_get (rl2WmsCatalogPtr
handle);
/**
Return the GetFeatureInfo URL (method POST) from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the corresponding URL: NULL if the URL is not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetMap_get, get_wms_url_GetMap_post,
get_wms_url_GetTileService_get, get_wms_url_GetTileService_post,
get_wms_url_GetFeatureInfo_get, get_wms_gml_mime_type, get_wms_xml_mime_type
*/
RL2_DECLARE const char *get_wms_url_GetFeatureInfo_post (rl2WmsCatalogPtr
handle);
/**
Return the GML MIME type name from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the MIME type corresponding to GML: NULL if it's not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetFeatureInfo_get, get_wms_url_GetFeatureInfo_post,
get_wms_xml_mime_type
*/
RL2_DECLARE const char *get_wms_gml_mime_type (rl2WmsCatalogPtr handle);
/**
Return the XML MIME type name from a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the MIME type corresponding to XML: NULL if it's not defined or if any error is encountered.
\sa create_wms_catalog, get_wms_url_GetFeatureInfo_get, get_wms_url_GetFeatureInfo_post,
get_wms_gml_mime_type
*/
RL2_DECLARE const char *get_wms_xml_mime_type (rl2WmsCatalogPtr handle);
/**
Return the Contact Person defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Contact Person: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_person (rl2WmsCatalogPtr handle);
/**
Return the Contact Organization defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Contact Organization: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_organization (rl2WmsCatalogPtr
handle);
/**
Return the Contact Position defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Contact Position: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_position (rl2WmsCatalogPtr handle);
/**
Return the Postal Address defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Postal Address: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_postal_address (rl2WmsCatalogPtr
handle);
/**
Return the City (Postal Address) defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the City (Postal Address): NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_city (rl2WmsCatalogPtr handle);
/**
Return the State or Provicne (Postal Address) defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the State or Province (Postal Address): NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_state_province (rl2WmsCatalogPtr
handle);
/**
Return the Post Code (Postal Address) defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Post Code (Postal Address) : NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_post_code (rl2WmsCatalogPtr handle);
/**
Return the Country (Postal Address) defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Country (Postal Address): NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_country (rl2WmsCatalogPtr handle);
/**
Return the Voice Telephone defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the Voice Telephone: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_voice_telephone (rl2WmsCatalogPtr
handle);
/**
Return the FAX Telephone defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the FAX Telephone: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_fax_telephone (rl2WmsCatalogPtr
handle);
/**
Return the e-mail Address defined by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the e-mail Address: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_contact_email_address (rl2WmsCatalogPtr
handle);
/**
Return the Fees required by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the required Fees: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_fees (rl2WmsCatalogPtr handle);
/**
Return the Access Constraints supported by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the imposed Access Constraints: NULL if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_access_constraints (rl2WmsCatalogPtr
handle);
/**
Return the Layer Limit supported by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the supported Layer Limit: a negative number if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE int get_wms_layer_limit (rl2WmsCatalogPtr handle);
/**
Return the MaxWidth supported by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the MaxWidth measured in pixels: a negative number if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE int get_wms_max_width (rl2WmsCatalogPtr handle);
/**
Return the MaxHeight supported by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\return the MaxHeight measured in pixels: a negative number if undeclared/unspecified.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE int get_wms_max_height (rl2WmsCatalogPtr handle);
/**
Return one of the Formats supported by a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\param index the relative index identifying the required Format (the first
Format value supported by a WMS-Catalog object has index ZERO).
\param mode TRUE if only valid "image formats" should be considered;
if set to FALSE then any possible format will be considered.
\return the Format string: NULL if the required Format isn't defined.
\sa create_wms_catalog, get_wms_format_count
*/
RL2_DECLARE const char *get_wms_format (rl2WmsCatalogPtr handle,
int index, int mode);
/**
Return the pointer to some specific Layer defined within a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog returned by a previous call
to create_wms_catalog()
\param index the relative index identifying the required WMS-Layer (the first
Layer in the WMS-Catalaog object has index ZERO).
\return the pointer to the required WMS-Layer object: NULL if the passed index
isn't valid
\sa create_wms_catalog, get_wms_catalog_count, get_wms_layer_name, get_wms_layer_title,
get_wms_layer_abstract, get_wms_layer_crs_count, get_wms_layer_crs
*/
RL2_DECLARE rl2WmsLayerPtr get_wms_catalog_layer (rl2WmsCatalogPtr
handle, int index);
/**
Testing if some WMS-Layer object has Layer children
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return 0 (false) if not, any other value if yes
\sa get_wms_catalog_layer, get_wms_layer_children_count, get_wms_child_layer
*/
RL2_DECLARE int wms_layer_has_children (rl2WmsLayerPtr handle);
/**
Return the total count of children Layers defined within a WMS-Layer object
\param handle the pointer to a valid WMS-Layer
\return the total count of children Layers defined within a WMS-Layer object:
a negative number if the WMS-Layer isn't valid
\sa get_wms_catalog_layer, wms_layer_has_children, get_wms_child_layer
*/
RL2_DECLARE int get_wms_layer_children_count (rl2WmsLayerPtr handle);
/**
Return the pointer to some child Layer defined within a WMS-Layer object
\param handle the pointer to a valid WMS-Layer
\param index the relative index identifying the required WMS-Layer (the first
child Layer in the WMS-Layer object has index ZERO).
\return the pointer to the required WMS-Layer object: NULL if the passed index
isn't valid
\sa get_wms_catalog_layer, wms_layer_has_children, get_wms_layer_children_count
*/
RL2_DECLARE rl2WmsLayerPtr get_wms_child_layer (rl2WmsLayerPtr
handle, int index);
/**
Return the name corresponding to some WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the name corresponding to the WMS-Layer object
\sa get_wms_layer_title, get_wms_layer_abstract, get_wms_layer_crs_count, get_wms_layer_crs,
wms_layer_has_children
*/
RL2_DECLARE const char *get_wms_layer_name (rl2WmsLayerPtr handle);
/**
Return the title corresponding to some WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the title corresponding to the WMS-Layer object
\sa get_wms_layer_name, get_wms_layer_abstract, get_wms_layer_crs_count, get_wms_layer_crs
*/
RL2_DECLARE const char *get_wms_layer_title (rl2WmsLayerPtr handle);
/**
Return the abstract corresponding to some WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the abstract corresponding to the WMS-Layer object
\sa get_wms_layer_name, get_wms_layer_title, get_wms_layer_crs_count, get_wms_layer_crs
*/
RL2_DECLARE const char *get_wms_layer_abstract (rl2WmsLayerPtr handle);
/**
Return the total count of CRSs supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the total count of CRSs supported by a WMS-Layer object:
ZERO or a negative number if the WMS-Layer isn't valid
\sa get_wms_layer_name, get_wms_layer_title, get_wms_layer_abstract,
get_wms_layer_crs, get_wms_layer_style_count
*/
RL2_DECLARE int get_wms_layer_crs_count (rl2WmsLayerPtr handle);
/**
Return one of the CRSs supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\param index the relative index identifying the required CRS (the first
CRS value supported by a WMS-Layer object has index ZERO).
\return the CRS string: NULL if the required CRS isn't defined.
\sa get_wms_layer_name, get_wms_layer_title, get_wms_layer_abstract,
get_wms_layer_crs_count
*/
RL2_DECLARE const char *get_wms_layer_crs (rl2WmsLayerPtr handle,
int index);
/**
Tests if some WMS-Layer object declares the Opaque property
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return TRUE or FALSE: a negative number if undefined/unspecified or if
isn't a valid WMS-Layer.
\sa get_wms_layer_name, get_wms_layer_title, get_wms_layer_abstract,
is_wms_layer_queriable
*/
RL2_DECLARE int is_wms_layer_opaque (rl2WmsLayerPtr handle);
/**
Tests if some WMS-Layer object declares the Queryable property
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return TRUE or FALSE: a negative number if undefined/unspecified or if
isn't a valid WMS-Layer.
\sa get_wms_layer_name, get_wms_layer_title, get_wms_layer_abstract,
is_wms_layer_transparent
*/
RL2_DECLARE int is_wms_layer_queryable (rl2WmsLayerPtr handle);
/**
Return the total count of Styles supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the total count of Styles supported by a WMS-Layer object:
ZERO or a negative number if the WMS-Layer isn't valid
\sa get_wms_layer_crs_count, get_wms_layer_style_name, get_wms_layer_style_title,
get_wms_layer_style_abstract
*/
RL2_DECLARE int get_wms_layer_style_count (rl2WmsLayerPtr handle);
/**
Return the Min Scale Denominator supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the Min Scale Denominator declared by a WMS-Layer object:
DBL_MAX if undeclared or if the WMS-Layer isn't valid
\sa get_wms_layer_crs_count, get_wms_layer_max_scale_denominator
*/
RL2_DECLARE double get_wms_layer_min_scale_denominator (rl2WmsLayerPtr
handle);
/**
Return the Max Scale Denominator supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\return the Max Scale Denominator declared by a WMS-Layer object:
DBL_MAX if undeclared or if the WMS-Layer isn't valid
\sa get_wms_layer_crs_count, get_wms_layer_min_scale_denominator
*/
RL2_DECLARE double get_wms_layer_max_scale_denominator (rl2WmsLayerPtr
handle);
/**
Return the Geographic Bounding Box (long/lat) declared by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\param minx on successful completion will contain the Min Longitude
\param maxx on successful completion will contain the Max Longitude
\param miny on successful completion will contain the Min Latitude
\param maxy on successful completion will contain the Max Latitude
\return TRUE on success, FALSE if any error occurred
\sa get_wms_layer_bbbox
*/
RL2_DECLARE int get_wms_layer_geo_bbox (rl2WmsLayerPtr handle, double *minx,
double *maxx, double *miny,
double *maxy);
/**
Return the Bounding Box corresponding to some CRS declared by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\param crs the string value identifying some specific CRS
\param minx on successful completion will contain the Min Longitude
\param maxx on successful completion will contain the Max Longitude
\param miny on successful completion will contain the Min Latitude
\param maxy on successful completion will contain the Max Latitude
\return TRUE on success, FALSE if any error occurred
\sa get_wms_layer_geo_bbox
*/
RL2_DECLARE int get_wms_layer_bbox (rl2WmsLayerPtr handle, const char *crs,
double *minx, double *maxx,
double *miny, double *maxy);
/**
Return the Name of some Style supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\param index the relative index identifying the required Style (the first
Style supported by a WMS-Layer object has index ZERO).
\return the Style's Name: NULL if the required Style isn't defined.
\sa get_wms_layer_style_count, get_wms_layer_style_title, get_wms_layer_style_abstract
*/
RL2_DECLARE const char *get_wms_layer_style_name (rl2WmsLayerPtr handle,
int index);
/**
Return the Title of some Style supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\param index the relative index identifying the required Style (the first
Style supported by a WMS-Layer object has index ZERO).
\return the Style's Title: NULL if the required Style isn't defined.
\sa get_wms_layer_style_count, get_wms_layer_style_name, get_wms_layer_style_abstract
*/
RL2_DECLARE const char *get_wms_layer_style_title (rl2WmsLayerPtr handle,
int index);
/**
Return the Abstract of some Style supported by a WMS-Layer object
\param handle the pointer to a valid WMS-Layer returned by a previous call
to get_wms_catalog_layer().
\param index the relative index identifying the required Style (the first
Style supported by a WMS-Layer object has index ZERO).
\return the Style's Abstract: NULL if the required Style isn't defined.
\sa get_wms_layer_style_count, get_wms_layer_style_name, get_wms_layer_style_title
*/
RL2_DECLARE const char *get_wms_layer_style_abstract (rl2WmsLayerPtr handle,
int index);
/**
Return the pointer to some specific Tiled Layer defined within a WMS-Catalog object
\param handle the pointer to a valid WMS-Catalog [of the TileService type]
returned by a previous call to create_wms_catalog()
\param index the relative index identifying the required WMS-TiledLayer (the first
Tiled Layer in the WMS-Catalaog object has index ZERO).
\return the pointer to the required WMS-TiledLayer object: NULL if the passed index
isn't valid
\sa create_wms_catalog, get_wms_tile_service_count, get_wms_tiled_layer_name,
get_wms_tiled_layer_title, get_wms_tiled_layer_abstract, get_wms_tiled_layer_crs
*/
RL2_DECLARE rl2WmsTiledLayerPtr
get_wms_catalog_tiled_layer (rl2WmsCatalogPtr handle, int index);
/**
Testing if some WMS-TiledLayer object has TiledLayer children
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_tiled_layer().
\return 0 (false) if not, any other value if yes
\sa get_wms_catalog_tiled_layer, get_wms_tiled_layer_children_count, get_wms_child_tiled_layer
*/
RL2_DECLARE int wms_tiled_layer_has_children (rl2WmsTiledLayerPtr handle);
/**
Return the total count of children TiledLayers defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\return the total count of children TiledLayers defined within a WMS-TiledLayer object:
a negative number if the WMS-TiledLayer isn't valid
\sa get_wms_catalog_tiled_layer, wms_tiled_layer_has_children, get_wms_child_layer
*/
RL2_DECLARE int get_wms_tiled_layer_children_count (rl2WmsTiledLayerPtr
handle);
/**
Return the pointer to some child TiledLayer defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TiledLayer (the first
child Layer in the WMS-TiledLayer object has index ZERO).
\return the pointer to the required WMS-TiledLayer object: NULL if the passed index
isn't valid
\sa get_wms_catalog_tiled_layer, wms_tiled_layer_has_children, get_wms_tiled_layer_children_count
*/
RL2_DECLARE rl2WmsTiledLayerPtr
get_wms_child_tiled_layer (rl2WmsTiledLayerPtr handle, int index);
/**
Return the name corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the name corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_title, get_wms_tiled_layer_abstract, get_wms_tiled_layer_crs,
get_wms_tiled_layer_format, get_wms_tiled_layer_style, get_wms_tiled_layer_pad,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_name (rl2WmsTiledLayerPtr
handle);
/**
Return the title corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the title corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_abstract, get_wms_tiled_layer_crs,
get_wms_tiled_layer_format, get_wms_tiled_layer_style, get_wms_tiled_layer_pad,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_title (rl2WmsTiledLayerPtr
handle);
/**
Return the abstract corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the abstract corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_crs,
get_wms_tiled_layer_format, get_wms_tiled_layer_style, get_wms_tiled_layer_pad,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_abstract (rl2WmsTiledLayerPtr
handle);
/**
Return the CRS corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the CRS corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_abstract,
get_wms_tiled_layer_format, get_wms_tiled_layer_style, get_wms_tiled_layer_pad,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children
*/
RL2_DECLARE const char *get_wms_tiled_layer_crs (rl2WmsTiledLayerPtr
handle);
/**
Return the Format corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the Format corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_abstract,
get_wms_tiled_layer_crs, get_wms_tiled_layer_style, get_wms_tiled_layer_pad,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_format (rl2WmsTiledLayerPtr
handle);
/**
Return the Style corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the Style corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_abstract,
get_wms_tiled_layer_crs, get_wms_tiled_layer_format, get_wms_tiled_layer_pad,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_style (rl2WmsTiledLayerPtr
handle);
/**
Return the Pad corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the Pad corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_abstract,
get_wms_tiled_layer_crs, get_wms_tiled_layer_format, get_wms_tiled_layer_style,
get_wms_tiled_layer_bands, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children
*/
RL2_DECLARE const char *get_wms_tiled_layer_pad (rl2WmsTiledLayerPtr
handle);
/**
Return the Bands corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the Bands corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_abstract,
get_wms_tiled_layer_crs, get_wms_tiled_layer_format, get_wms_tiled_layer_style,
get_wms_tiled_layer_pad, get_wms_tiled_layer_data_type, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_bands (rl2WmsTiledLayerPtr
handle);
/**
Return the DataType corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\return the DataType corresponding to the WMS-TiledLayer object
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title, get_wms_tiled_layer_abstract,
get_wms_tiled_layer_crs, get_wms_tiled_layer_format, get_wms_tiled_layer_style,
get_wms_tiled_layer_pad, get_wms_tiled_layer_bands, get_wms_tiled_layer_bbox,
wms_tiled_layer_has_children, get_wms_tile_pattern_count
*/
RL2_DECLARE const char *get_wms_tiled_layer_data_type (rl2WmsTiledLayerPtr
handle);
/**
Return the BoundingBox corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\param minx on successful completion will contain the Min Longitude
\param maxx on successful completion will contain the Max Longitude
\param miny on successful completion will contain the Min Latitude
\param maxy on successful completion will contain the Max Latitude
\return 0 on error, any other value on success
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title,
get_wms_tiled_layer_abstract, get_wms_tiled_layer_crs, get_wms_tiled_layer_format,
get_wms_tiled_layer_style, get_wms_tiled_layer_pad, get_wms_tiled_layer_bands,
get_wms_tiled_layer_data_type, wms_tiled_layer_has_children,
get_wms_tiled_layer_tile_size, get_wms_tile_pattern_count,
get_wms_tile_pattern_handle
*/
RL2_DECLARE int get_wms_tiled_layer_bbox (rl2WmsTiledLayerPtr handle,
double *minx, double *miny,
double *maxx, double *maxy);
/**
Return the Tile Size corresponding to some WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer returned by a previous call
to get_wms_catalog_layer().
\param width on successful completion will contain the Tile Width
\param height on successful completion will contain the Tile Height
\return 0 on error, any other value on success
\sa get_wms_tiled_layer_name, get_wms_tiled_layer_title,
get_wms_tiled_layer_abstract, get_wms_tiled_layer_crs, get_wms_tiled_layer_format,
get_wms_tiled_layer_style, get_wms_tiled_layer_pad, get_wms_tiled_layer_bands,
get_wms_tiled_layer_data_type, wms_tiled_layer_has_children,
get_wms_tiled_layer_bbox, get_wms_tile_pattern_count,
get_wms_tile_pattern_handle
*/
RL2_DECLARE int get_wms_tiled_layer_tile_size (rl2WmsTiledLayerPtr handle,
int *width, int *height);
/**
Return the total count of TiledPatterns defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\return the total count of TiledPatterns defined within a WMS-TiledLayer object:
a negative number if the WMS-TiledLayer isn't valid
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_tile_height,
get_wms_tile_pattern_base_x, get_wms_tile_pattern_base_y,
get_wms_tile_pattern_extent_x, get_wms_tile_pattern_handle
*/
RL2_DECLARE int get_wms_tile_pattern_count (rl2WmsTiledLayerPtr handle);
/**
Return the SRS from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the SRS defined within a WMS-TilePattern object:
NULL if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_tile_width,
get_wms_tile_pattern_tile_height, get_wms_tile_pattern_base_x,
get_wms_tile_pattern_base_y, get_wms_tile_pattern_extent_x,
get_wms_tile_pattern_extent_y, get_wms_tile_pattern_handle
*/
RL2_DECLARE const char *get_wms_tile_pattern_srs (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the TileWidth from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the TileWidth defined within a WMS-TilePattern object:
a negative value if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_height, get_wms_tile_pattern_base_x,
get_wms_tile_pattern_base_y, get_wms_tile_pattern_extent_x,
get_wms_tile_pattern_extent_y, get_wms_tile_pattern_handle
*/
RL2_DECLARE int get_wms_tile_pattern_tile_width (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the TileHeight from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the TileHeight defined within a WMS-TilePattern object:
a negative value if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_base_x,
get_wms_tile_pattern_base_y, get_wms_tile_pattern_extent_x,
get_wms_tile_pattern_extent_y, get_wms_tile_pattern_handle
*/
RL2_DECLARE int get_wms_tile_pattern_tile_height (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the TileBaseX from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the TileBaseX (leftmost coord) defined within a WMS-TilePattern object:
DBL_MAX if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_tile_height,
get_wms_tile_pattern_base_y, get_wms_tile_pattern_extent_x,
get_wms_tile_pattern_extent_y, get_wms_tile_pattern_handle
*/
RL2_DECLARE double get_wms_tile_pattern_base_x (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the TileBaseY from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the TileBaseY (topmost coord) defined within a WMS-TilePattern object:
DBL_MAX if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_tile_height,
get_wms_tile_pattern_base_x, get_wms_tile_pattern_extent_x,
get_wms_tile_pattern_extent_y, get_wms_tile_pattern_handle
*/
RL2_DECLARE double get_wms_tile_pattern_base_y (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the TileExtentX from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the TileExtentX defined within a WMS-TilePattern object:
DBL_MAX if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_tile_height,
get_wms_tile_pattern_base_x, get_wms_tile_pattern_base_y,
get_wms_tile_pattern_extent_y, get_wms_tile_pattern_handle
*/
RL2_DECLARE double get_wms_tile_pattern_extent_x (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the TileExtentY from a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the TileExtentX defined within a WMS-TilePattern object:
DBL_MAX if the WMS-TilePattern isn't valid.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_tile_height,
get_wms_tile_pattern_base_x, get_wms_tile_pattern_base_y,
get_wms_tile_pattern_extent_x, get_wms_tile_pattern_handle
*/
RL2_DECLARE double get_wms_tile_pattern_extent_y (rl2WmsTiledLayerPtr
handle, int index);
/**
Return the handle for some TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TiledLayer
\param pattern_index the relative index identifying the required WMS-TilePattern (the first
TilePattern Layer in the WMS-TiledLayer object has index ZERO).
\return the handle for some TilePattern object inside
a WMS-TiledLayer object: NULL if any error is encountered.
\sa get_wms_tile_pattern_count, get_wms_tile_pattern_srs,
get_wms_tile_pattern_tile_width, get_wms_tile_pattern_tile_height,
get_wms_tile_pattern_base_x, get_wms_tile_pattern_base_y,
get_wms_tile_pattern_extent_x, get_wms_tile_pattern_extent_y
*/
RL2_DECLARE rl2WmsTilePatternPtr
get_wms_tile_pattern_handle (rl2WmsTiledLayerPtr handle, int index);
/**
Return a cloned copy of some TilePattern object
\param handle the pointer to a valid WMS-TilePattern returned by get_wms_tile_pattern_handle()
\return the handle to the new TilePattern: NULL if any error is encountered.
\sa get_wms_tile_pattern_handle, destroy_wms_tile_pattern,
get_wms_tile_pattern_sample_url, get_wms_tile_pattern_request_url
\note you are responsible to destroy before or after any WMS-TilePattern
object created by clone_wms_tile_pattern() by invoking destroy_wms_tile_pattern().
*/
RL2_DECLARE rl2WmsTilePatternPtr
clone_wms_tile_pattern (rl2WmsTilePatternPtr handle);
/**
Destroys a cloned copy of some TilePattern object
\param handle the pointer to a valid WMS-TilePattern returned by clone_wms_tile_pattern_handle()
\sa get_wms_tile_pattern_handle, clone_wms_tile_pattern,
get_wms_tile_pattern_sample_url, get_wms_tile_pattern_request_url
*/
RL2_DECLARE void destroy_wms_tile_pattern (rl2WmsTilePatternPtr handle);
/**
Return the sample URL representing a TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TilePattern returned by get_wms_tile_pattern_handle()
\return the sample URL representing a TilePattern object inside
a WMS-TiledLayer object: NULL if any error is encountered.
\sa get_wms_tile_pattern_handle, clone_wms_tile_pattern, destroy_wms_tile_pattern,
get_wms_tile_pattern_request_url
\note the returned sample URL corresponds to dynamically allocated memory,
and thus requires to be deallocated by invoking sqlite3_free().
*/
RL2_DECLARE char *get_wms_tile_pattern_sample_url (rl2WmsTilePatternPtr
handle);
/**
Return the full request URL for some TiledPattern defined within a WMS-TiledLayer object
\param handle the pointer to a valid WMS-TilePattern returned by get_wms_tile_pattern_handle()
\return the full request URL for some TilePattern object inside
a WMS-TiledLayer object: NULL if any error is encountered.
\sa get_wms_tile_pattern_handle, clone_wms_tile_pattern, destroy_wms_tile_pattern,
, get_wms_tile_pattern_sample_url
\note the returned full request URL corresponds to dynamically allocated memory,
and thus requires to be deallocated by invoking sqlite3_free().
*/
RL2_DECLARE char *get_wms_tile_pattern_request_url (rl2WmsTilePatternPtr
handle,
const char *base_url,
double min_x,
double min_y);
/**
Creates a WMS-Cache object
\return the pointer to the corresponding WMS-Cache object: NULL on failure
\sa destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size, set_wms_cache_max_size,
get_wms_cache_items_count, get_wms_cache_current_size, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
\note you are responsible to destroy (before or after) any WMS-Cache created by create_wms_cache().
*/
RL2_DECLARE rl2WmsCachePtr create_wms_cache (void);
/**
Destroys a WMS-Cache object freeing any allocated resource
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\sa create_wms_cache, reset_wms_cache, get_wms_cache_max_size, set_wms_cache_max_size,
get_wms_cache_items_count, get_wms_cache_current_size, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE void destroy_wms_cache (rl2WmsCachePtr handle);
/**
Resets a WMS-Cache object to its initial empty state.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\sa create_wms_cache, destroy_wms_cache, get_wms_cache_max_size, set_wms_cache_max_size,
get_wms_cache_items_count, get_wms_cache_current_size, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE void reset_wms_cache (rl2WmsCachePtr handle);
/**
Return the current Max-Size from a WMS-Cache object.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the currently set MaxSize (in bytes) from some WMS-Cache object.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, set_wms_cache_max_size,
get_wms_cache_items_count, get_wms_cache_current_size, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE int get_wms_cache_max_size (rl2WmsCachePtr handle);
/**
Chages the current Max Size for a WMS-Cache object.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\param size the new Max Size (in bytes) to be set.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
get_wms_cache_items_count, get_wms_cache_current_size, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
\note if the WMS-Cache currently uses more memory than allowed by the new setting
any allocation in excess will be immediately freed.
*/
RL2_DECLARE void set_wms_cache_max_size (rl2WmsCachePtr handle, int size);
/**
Return the current number of cached items stored within a WMS-Cache object.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the current number of cached items stored within a WMS-Cache object.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
set_wms_cache_max_size, get_wms_cache_current_size, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE int get_wms_cache_items_count (rl2WmsCachePtr handle);
/**
Return the current memory allocation used by a WMS-Cache object.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the current memory allocation (in bytes) used by a WMS-Cache object.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
set_wms_cache_max_size, get_wms_cache_items_count, get_wms_cache_hit_count,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE int get_wms_cache_current_size (rl2WmsCachePtr handle);
/**
Return the current total number of cache-hit events from a WMS-Cache object.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the current total number of cache-hit events from a WMS-Cache object.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
set_wms_cache_max_size, get_wms_cache_items_count, get_wms_cache_current_size,
get_wms_cache_miss_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE int get_wms_cache_hit_count (rl2WmsCachePtr handle);
/**
Return the current total number of cache-miss events from a WMS-Cache object.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the current total number of cache-miss events from a WMS-Cache object.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
set_wms_cache_max_size, get_wms_cache_items_count, get_wms_cache_current_size,
get_wms_cache_hit_count, get_wms_cache_flushed_count, get_wms_total_download_size
*/
RL2_DECLARE int get_wms_cache_miss_count (rl2WmsCachePtr handle);
/**
Return the current size of memory allocations previously used by a WMS-Cache
object but now definitely released.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the current size of memory allocations (in bytes) previously used
by a WMS-Cache object but now definitely released.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
set_wms_cache_max_size, get_wms_cache_items_count, get_wms_cache_current_size,
get_wms_cache_hit_count, get_wms_cache_miss_count, get_wms_total_download_size
*/
RL2_DECLARE int get_wms_cache_flushed_count (rl2WmsCachePtr handle);
/**
Return the total size (in bytes) of all cache items since the beginning of
the file cycle of some WMS-Cache.
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\return the total size (in bytes) of all cache items since the beginning of
the file cycle of some WMS-Cache object.
\sa create_wms_cache, destroy_wms_cache, reset_wms_cache, get_wms_cache_max_size,
set_wms_cache_max_size, get_wms_cache_items_count, get_wms_cache_current_size,
get_wms_cache_hit_count, get_wms_cache_miss_count, get_wms_cache_flushed_count
*/
RL2_DECLARE double get_wms_total_download_size (rl2WmsCachePtr handle);
/**
Performs a WMS GetMap request - HTTP GET
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\param url the WebServive base URL.
\param proxy an optional HTTP Proxy string: could be eventually NULL.
\param version a string identifying the version of the WMS protocol to be used.
\param layer name of the requested WMS-Layer.
\param a string identifying the CRS/SRS.
\param swap_xy a boolean value used to select between normal [XY] or flipped
[LatLon] axes ordering.
\param minx BoundingBox: X min coordinate.
\param miny BoundingBox: Y min coordinate.
\param maxx BoundingBox: X max coordinate.
\param maxy BoundingBox: Y max coordinate.
\param width horizontal dimension (in pixels) of the requested image.
\param height vertical dimension (in pixels) of the requested image.
\param style a string identifying some SLD Style; could be eventually NULL.
\param format a string indentifying the MIME type of the requested image.
\param opaque a boolean valued used to select if the requested image
should be either opaque or transparent.
\param from_cache boolean value: if TRUE simply an attempt to retrieve
the requested image from cached data will be performed.\n
Otherwise a full HTTP request will be forwarded for any uncached request.
\param err_msg on completion will contain an error message (if any)
\return a pointer to an RGBA buffer containing the requested image:
NULL if any error is encountered.
\sa do_wms_GetMap_post, do_wms_GetMap_TileService_get,
do_wms_GetMap_TileService_post, do_wms_GetFeatureInfo_get,
do_wms_GetFeatureInfo_post
\note the returned RGBA corresponds to dynamically allocated memory,
and thus requires to be deallocated before or after.\n
An eventual error message returned via err_msg requires to be deallocated
by invoking free().
*/
RL2_DECLARE unsigned char *do_wms_GetMap_get (rl2WmsCachePtr handle,
const char *url,
const char *proxy,
const char *version,
const char *layer,
const char *crs, int swap_xy,
double minx, double miny,
double maxx, double maxy,
int width, int height,
const char *style,
const char *format,
int opaque, int from_cache,
char **err_msg);
/**
Performs a WMS GetMap request - HTTP POST
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\param url the WebServive base URL.
\param proxy an optional HTTP Proxy string: could be eventually NULL.
\param version a string identifying the version of the WMS protocol to be used.
\param layer name of the requested WMS-Layer.
\param a string identifying the CRS/SRS
\param swap_xy a boolean value used to select between normal [XY] or flipped
[LatLon] axes ordering.
\param minx BoundingBox: X min coordinate.
\param miny BoundingBox: Y min coordinate.
\param maxx BoundingBox: X max coordinate.
\param maxy BoundingBox: Y max coordinate.
\param width horizontal dimension (in pixels) of the requested image.
\param height vertical dimension (in pixels) of the requested image.
\param style a string identifying some SLD Style; could be eventually NULL.
\param format a string indentifying the MIME type of the requested image.
\param opaque a boolean valued used to select if the requested image
should be either opaque or transparent.
\param from_cache boolean value: if TRUE simply an attempt to retrieve
the requested image from cached data will be performed.\n
Otherwise a full HTTP request will be forwarded for any uncached request.
\param err_msg on completion will contain an error message (if any)
\return a pointer to an RGBA buffer containing the requested image:
NULL if any error is encountered.\n
<bCurrently unimplemented: will always return NULL</b>
\sa do_wms_GetMap_get, do_wms_GetMap_TileService_get,
do_wms_GetMap_TileService_post, do_wms_GetFeatureInfo_get,
do_wms_GetFeatureInfo_post
\note the returned RGBA corresponds to dynamically allocated memory,
and thus requires to be deallocated before or after.\n
An eventual error message returned via err_msg requires to be deallocated
by invoking free().
*/
RL2_DECLARE unsigned char *do_wms_GetMap_post (rl2WmsCachePtr handle,
const char *url,
const char *proxy,
const char *version,
const char *layer,
const char *crs, int swap_xy,
double minx, double miny,
double maxx, double maxy,
int width, int height,
const char *style,
const char *format,
int opaque, int from_cache,
char **err_msg);
/**
Performs a WMS GetMap [TileService] request - HTTP GET
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\param url full TileService GetMap request URL.
\param proxy an optional HTTP Proxy string: could be eventually NULL.
\param width horizontal dimension (in pixels) of the requested image.
\param height vertical dimension (in pixels) of the requested image.
\param from_cache boolean value: if TRUE simply an attempt to retrieve
the requested image from cached data will be performed.\n
Otherwise a full HTTP request will be forwarded for any uncached request.
\param err_msg on completion will contain an error message (if any)
\return a pointer to an RGBA buffer containing the requested image:
NULL if any error is encountered.
\sa do_wms_GetMap_get, do_wms_GetMap_post,
do_wms_GetMap_TileService_post, do_wms_GetFeatureInfo_get,
do_wms_GetFeatureInfo_post
\note the returned RGBA corresponds to dynamically allocated memory,
and thus requires to be deallocated before or after.\n
An eventual error message returned via err_msg requires to be deallocated
by invoking free().
*/
RL2_DECLARE unsigned char *do_wms_GetMap_TileService_get (rl2WmsCachePtr
handle,
const char *url,
const char *proxy,
int width,
int height,
int from_cache,
char **err_msg);
/**
Performs a WMS GetMap [TileService] request - HTTP POST
\param handle the pointer to a valid WMS-Cache returned by a previous call
to create_wms_cache()
\param url full TileService GetMap request URL.
\param proxy an optional HTTP Proxy string: could be eventually NULL.
\param width horizontal dimension (in pixels) of the requested image.
\param height vertical dimension (in pixels) of the requested image.
\param from_cache boolean value: if TRUE simply an attempt to retrieve
the requested image from cached data will be performed.\n
Otherwise a full HTTP request will be forwarded for any uncached request.
\param err_msg on completion will contain an error message (if any)
\return a pointer to an RGBA buffer containing the requested image:
NULL if any error is encountered.\n
<bCurrently unimplemented: will always return NULL</b>
\sa do_wms_GetMap_get, do_wms_GetMap_post,
do_wms_GetMap_TileService_get, do_wms_GetFeatureInfo_get,
do_wms_GetFeatureInfo_post
\note the returned RGBA corresponds to dynamically allocated memory,
and thus requires to be deallocated before or after.\n
An eventual error message returned via err_msg requires to be deallocated
by invoking free().
*/
RL2_DECLARE unsigned char *do_wms_GetMap_TileService_post (rl2WmsCachePtr
handle,
const char *url,
const char
*proxy,
int width,
int height,
int from_cache,
char **err_msg);
/**
Performs a WMS GetFeatureInfo request - HTTP GET
\param url the WebServive base URL.
\param proxy an optional HTTP Proxy string: could be eventually NULL.
\param version a string identifying the version of the WMS protocol to be used.
\param format a string indentifying the MIME type of the requested image.
\param layer name of the requested WMS-Layer.
\param a string identifying the CRS/SRS
\param swap_xy a boolean value used to select between normal [XY] or flipped
[LatLon] axes ordering.
\param minx BoundingBox: X min coordinate.
\param miny BoundingBox: Y min coordinate.
\param maxx BoundingBox: X max coordinate.
\param maxy BoundingBox: Y max coordinate.
\param width horizontal dimension (in pixels) of the requested image.
\param height vertical dimension (in pixels) of the requested image.
\param img_x X coordinate (in pixels) of the point to be queryied.
\param img_y Y coordinate (in pixels) of the point to be queryied.
\param err_msg on completion will contain an error message (if any)
\return a pointer to a WMS-FeatureCollection object:
NULL if any error is encountered or if no result is available.
\sa do_wms_GetMap_get, do_wms_GetMap_post, do_wms_GetMap_TileService_get,
do_wms_GetMap_TileService_post, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_members_count
\note the returned WMS-FeatureCollection corresponds to dynamically allocated memory,
and thus requires to be deallocated before or after by invoking destroy_wms_feature_collection().\n
An eventual error message returned via err_msg requires to be deallocated
by invoking free().
*/
RL2_DECLARE rl2WmsFeatureCollectionPtr
do_wms_GetFeatureInfo_get (const char *url,
const char *proxy,
const char *version,
const char *format,
const char *layer,
const char *crs,
int swap_xy,
double minx,
double miny,
double maxx,
double maxy,
int width, int height,
int img_x, int img_y, char **err_msg);
/**
Performs a WMS GetFeatureInfo request - HTTP POST
\param url the WebServive base URL.
\param proxy an optional HTTP Proxy string: could be eventually NULL.
\param version a string identifying the version of the WMS protocol to be used.
\param format a string indentifying the MIME type of the requested image.
\param layer name of the requested WMS-Layer.
\param a string identifying the CRS/SRS
\param swap_xy a boolean value used to select between normal [XY] or flipped
[LatLon] axes ordering.
\param minx BoundingBox: X min coordinate.
\param miny BoundingBox: Y min coordinate.
\param maxx BoundingBox: X max coordinate.
\param maxy BoundingBox: Y max coordinate.
\param width horizontal dimension (in pixels) of the requested image.
\param height vertical dimension (in pixels) of the requested image.
\param img_x X coordinate (in pixels) of the point to be queried.
\param img_y Y coordinate (in pixels) of the point to be queried.
\param err_msg on completion will contain an error message (if any)
\return a pointer to a WMS-FeatureCollection object:
NULL if any error is encountered or if no result is available.\n
<bCurrently unimplemented: will always return NULL</b>
\sa do_wms_GetMap_get, do_wms_GetMap_post, do_wms_GetMap_TileService_get,
do_wms_GetMap_TileService_post, do_wms_GetFeatureInfo_get,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_members_count
\note the returned WMS-FeatureCollection corresponds to dynamically allocated memory,
and thus requires to be deallocated before or after by invoking destroy_wms_feature_collection().\n
An eventual error message returned via err_msg requires to be deallocated
by invoking free().
*/
RL2_DECLARE rl2WmsFeatureCollectionPtr
do_wms_GetFeatureInfo_post (const char *url,
const char *proxy,
const char *version,
const char *format,
const char *layer,
const char *crs,
int swap_xy,
double minx,
double miny,
double maxx,
double maxy,
int width, int height,
int img_x, int img_y, char **err_msg);
/**
Destroys a WMS-FeatureCollection object freeing any allocated resource
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
wms_feature_collection_parse_geometries, get_wms_feature_members_count,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attribute_name, get_wms_feature_attribute_value,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE void destroy_wms_feature_collection (rl2WmsFeatureCollectionPtr
handle);
/**
Attempts to parse all GML Geometries from within a WMS-FeatureCollection object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\param srid the SRID value of the current Map
\param point_x X coordinate (in the Map CRS) identifying the queried Point.
\param point_y Y coordinate (in the Map CRS) identifying the queried Point.
\param sqlite handle to a valid SQLite connection - required in order to support
coordinate re-projections based on ST_Transform().
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, get_wms_feature_members_count,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attribute_name, get_wms_feature_attribute_value,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE void
wms_feature_collection_parse_geometries (rl2WmsFeatureCollectionPtr
handle, int srid,
double point_x, double point_y,
sqlite3 * sqlite);
/**
Return the total count of WMS-FeatureMembers from within a WMS_FeatureCollection object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\return the total count of WMS-FeatureMembers from within a WMS_FeatureCollection object.
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attribute_name, get_wms_feature_attribute_value,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE int get_wms_feature_members_count (rl2WmsFeatureCollectionPtr
handle);
/**
Return a pointer referencing the Nth WMS-FeatureMember from within a WMS_FeatureCollection object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\param index the relative index identifying the required FeatureMember (the first
Member supported by a WMS-FeatureCollection object has index ZERO).
\return a pointer referencing the Nth WMS-FeatureMember from within a WMS_FeatureCollection
object: NULL for empty/void collections or if any error occurs.
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attribute_name, get_wms_feature_attribute_value,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE rl2WmsFeatureMemberPtr
get_wms_feature_member (rl2WmsFeatureCollectionPtr handle, int index);
/**
Return a pointer the Name string of some WMS-FeatureMember object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\return a pointer the Name string of some WMS-FeatureMember object:
NULL if any error occurs.
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attribute_name, get_wms_feature_attribute_value,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE int get_wms_feature_attributes_count (rl2WmsFeatureMemberPtr
handle);
/**
Return a pointer the Nth AttributeName string from within some WMS-FeatureMember object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\param index the relative index identifying the required Attribute (the first
Attribute supported by a WMS-FeatureMember object has index ZERO).
\return a pointer the Nth AttributeName string of some WMS-FeatureMember object:
NULL if any error occurs.
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attributes_count, get_wms_feature_attribute_value,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE const char
*get_wms_feature_attribute_name (rl2WmsFeatureMemberPtr handle,
int index);
/**
Return a pointer the Nth AttributeValue string from within some WMS-FeatureMember object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\param index the relative index identifying the required Attribute (the first
Attribute supported by a WMS-FeatureMember object has index ZERO).
\return a pointer the Nth AttributeValue string of some WMS-FeatureMember object:
NULL if any error occurs. (please note: an AttributeValue could eventually correspond
to a NULL value by itself)
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attributes_count, get_wms_feature_attribute_name,
get_wms_feature_attribute_geometry
*/
RL2_DECLARE const char
*get_wms_feature_attribute_value (rl2WmsFeatureMemberPtr handle,
int index);
/**
Retrieves a SpatiaLite's BLOB binery geometry corresponding to the Nth
AttributeValue from within some WMS-FeatureMember object
\param handle the pointer to a valid WMS-FeatureCollection returned by a previous call
to do_wms_GetFeatureInfo_get() or do_wms_GetFeatureInfo_post()
\param index the relative index identifying the required Attribute (the first
Attribute supported by a WMS-FeatureMember object has index ZERO).
\param blob on completion will point to the BLOB binary Geometry.
\param blob_soze on completion the variable referenced by this
pointer will contain the size (in bytes) of BLOB. Geometry.
\return RL2_OK on success: RL2_ERROR on failure.
\sa do_wms_GetFeatureInfo_get, do_wms_GetFeatureInfo_post,
destroy_wms_feature_collection, wms_feature_collection_parse_geometries,
get_wms_feature_member, get_wms_feature_attributes_count,
get_wms_feature_attributes_count, get_wms_feature_attribute_name,
get_wms_feature_attribute_value
\note the returned BLOB Geometry simply is a reference, and must
absolutely not be destroyed by directly calling free().
*/
RL2_DECLARE int
get_wms_feature_attribute_blob_geometry (rl2WmsFeatureMemberPtr handle,
int index,
const unsigned char **blob,
int *blob_size);
#ifdef __cplusplus
}
#endif
#endif /* RL2WMS_H */
|