/usr/include/sbml/xml/XMLAttributes.h is in libsbml5-dev 5.10.0+dfsg-1.
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 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 | /**
* @file XMLAttributes.h
* @brief XMLAttributes are a list of name/value pairs for XML elements
* @author Ben Bornstein
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2014 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
* ------------------------------------------------------------------------ -->
*
* @class XMLAttributes
* @sbmlbrief{core} Representation of attributes on an XML node.
*
* @htmlinclude not-sbml-warning.html
*/
#ifndef XMLAttributes_h
#define XMLAttributes_h
#include <sbml/xml/XMLExtern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/common/operationReturnValues.h>
#ifdef __cplusplus
#include <string>
#include <vector>
#include <stdexcept>
#include <sbml/xml/XMLTriple.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class XMLErrorLog;
/** @cond doxygenLibsbmlInternal */
class XMLOutputStream;
/** @endcond */
class LIBLAX_EXTERN XMLAttributes
{
public:
/**
* Creates a new empty XMLAttributes set.
*/
XMLAttributes ();
/**
* Destroys this XMLAttributes set.
*/
virtual ~XMLAttributes ();
/**
* Copy constructor; creates a copy of this XMLAttributes set.
*
* @p orig the XMLAttributes object to copy.
*
* @throws @if python ValueError @else XMLConstructorException @endif@~
* Thrown if the argument @p orig is @c NULL.
*/
XMLAttributes(const XMLAttributes& orig);
/**
* Assignment operator for XMLAttributes.
*
* @param rhs The XMLAttributes object whose values are used as the basis
* of the assignment.
*
* @throws @if python ValueError @else XMLConstructorException @endif@~
* Thrown if the argument @p rhs is @c NULL.
*/
XMLAttributes& operator=(const XMLAttributes& rhs);
/**
* Creates and returns a deep copy of this XMLAttributes set.
*
* @return a (deep) copy of this XMLAttributes set.
*/
XMLAttributes* clone () const;
/**
* Adds an attribute (a name/value pair) to this XMLAttributes object,
* optionally with a prefix and URI defining a namespace.
*
* @param name a string, the local name of the attribute.
* @param value a string, the value of the attribute.
* @param namespaceURI a string, the namespace URI of the attribute.
* @param prefix a string, the prefix of the namespace
*
* @return an integer code indicating the success or failure of the
* function. The possible values returned by this
* function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*
* @note if local name with the same namespace URI already exists in this
* attribute set, its value and prefix will be replaced.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
int add ( const std::string& name
, const std::string& value
, const std::string& namespaceURI = ""
, const std::string& prefix = "");
/**
* Adds an attribute with the given XMLTriple/value pair to this XMLAttributes set.
*
* @note if local name with the same namespace URI already exists in this attribute set,
* its value and prefix will be replaced.
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value a string, the value of the attribute.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int add ( const XMLTriple& triple, const std::string& value);
/** @cond doxygenLibsbmlInternal */
/**
* Adds an name/value pair to this XMLAttributes set.
*
* This method is similar to the add method but an attribute with same name wont
* be overwritten. This facilitates the addition of multiple resource attributes
* in CVTerm class.
*
* @param name a string, the name of the attribute.
* @param value a string, the value of the attribute.
*
* @note This function is only internally used to store multiple rdf:resource
* attributes in CVTerm class, and thus should not be used for other purposes.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int addResource (const std::string& name, const std::string& value);
/** @endcond */
/**
* Removes an attribute with the given index from this XMLAttributes set.
*
* @param n an integer the index of the resource to be deleted
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
*/
int removeResource (int n);
/**
* Removes an attribute with the given index from this XMLAttributes set.
* (This function is an alias of XMLAttributes::removeResource(@if java int n@endif) ).
*
* @param n an integer the index of the resource to be deleted
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
*/
int remove (int n);
/**
* Removes an attribute with the given local name and namespace URI from
* this XMLAttributes set.
*
* @param name a string, the local name of the attribute.
* @param uri a string, the namespace URI of the attribute.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
*/
int remove (const std::string& name, const std::string& uri = "");
/**
* Removes an attribute with the given XMLTriple from this XMLAttributes set.
*
* @param triple an XMLTriple, the XML triple of the attribute.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
*/
int remove (const XMLTriple& triple);
/**
* Clears (deletes) all attributes in this XMLAttributes object.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int clear();
/**
* Return the index of an attribute with the given name.
*
* @note A namespace bound to the name is not checked by this function.
* Thus, if there are multiple attributes with the given local name and
* different namespaces, the smallest index among those attributes will
* be returned. XMLAttributes::getIndex(const std::string& name, const std::string& uri) const or
* XMLAttributes::getIndex(const XMLTriple& triple) const should be used to get an index of an
* attribute with the given local name and namespace.
*
* @param name a string, the local name of the attribute for which the
* index is required.
*
* @return the index of an attribute with the given local name, or -1 if not present.
*/
int getIndex (const std::string& name) const;
/**
* Return the index of an attribute with the given local name and namespace URI.
*
* @param name a string, the local name of the attribute.
* @param uri a string, the namespace URI of the attribute.
*
* @return the index of an attribute with the given local name and namespace URI,
* or -1 if not present.
*/
int getIndex (const std::string& name, const std::string& uri) const;
/**
* Return the index of an attribute with the given XMLTriple.
*
* @param triple an XMLTriple, the XML triple of the attribute for which
* the index is required.
*
* @return the index of an attribute with the given XMLTriple, or -1 if not present.
*/
int getIndex (const XMLTriple& triple) const;
/**
* Return the number of attributes in the set.
*
* @return the number of attributes in this XMLAttributes set.
*/
int getLength () const;
/**
* Return the number of attributes in the set.
*
* @return the number of attributes in this XMLAttributes set.
*
* This function is an alias for getLength introduced for consistency
* with other XML classes.
*/
int getNumAttributes () const;
/**
* Return the local name of an attribute in this XMLAttributes set (by position).
*
* @param index an integer, the position of the attribute whose local name is
* required.
*
* @return the local name of an attribute in this list (by position).
*
* @note If index is out of range, an empty string will be returned. Use
* XMLAttributes::hasAttribute(int index) const to test for the attribute
* existence.
*/
std::string getName (int index) const;
/**
* Return the prefix of an attribute in this XMLAttributes set (by position).
*
* @param index an integer, the position of the attribute whose prefix is
* required.
*
* @return the namespace prefix of an attribute in this list (by
* position).
*
* @note If index is out of range, an empty string will be returned. Use
* XMLAttributes::hasAttribute(int index) const to test for the attribute
* existence.
*/
std::string getPrefix (int index) const;
/**
* Return the prefixed name of an attribute in this XMLAttributes set (by position).
*
* @param index an integer, the position of the attribute whose prefixed
* name is required.
*
* @return the prefixed name of an attribute in this list (by
* position).
*
* @note If index is out of range, an empty string will be returned. Use
* XMLAttributes::hasAttribute(int index) const to test for attribute existence.
*/
std::string getPrefixedName (int index) const;
/**
* Return the namespace URI of an attribute in this XMLAttributes set (by position).
*
* @param index an integer, the position of the attribute whose namespace URI is
* required.
*
* @return the namespace URI of an attribute in this list (by position).
*
* @note If index is out of range, an empty string will be returned. Use
* XMLAttributes::hasAttribute(int index) const to test for attribute existence.
*/
std::string getURI (int index) const;
/**
* Return the value of an attribute in this XMLAttributes set (by position).
*
* @param index an integer, the position of the attribute whose value is
* required.
*
* @return the value of an attribute in the list (by position).
*
* @note If index is out of range, an empty string will be returned. Use
* XMLAttributes::hasAttribute(int index) const to test for attribute existence.
*/
std::string getValue (int index) const;
/**
* Return an attribute's value by name.
*
* @param name a string, the local name of the attribute whose value is required.
*
* @return The attribute value as a string.
*
* @note If an attribute with the given local name does not exist, an
* empty string will be returned. Use
* XMLAttributes::hasAttribute(const std::string name, const std::string uri) const
* to test for attribute existence. A namespace bound to the local name
* is not checked by this function. Thus, if there are multiple
* attributes with the given local name and different namespaces, the
* value of an attribute with the smallest index among those attributes
* will be returned. XMLAttributes::getValue(const std::string name) const or
* XMLAttributes::getValue(const XMLTriple& triple) const should be used to get a value of an
* attribute with the given local name and namespace.
*/
std::string getValue (const std::string name) const;
/**
* Return a value of an attribute with the given local name and namespace URI.
*
* @param name a string, the local name of the attribute whose value is required.
* @param uri a string, the namespace URI of the attribute.
*
* @return The attribute value as a string.
*
* @note If an attribute with the given local name and namespace URI does
* not exist, an empty string will be returned. Use
* XMLAttributes::hasAttribute(const std::string name, const std::string uri) const
* to test for attribute existence.
*/
std::string getValue (const std::string name, const std::string uri) const;
/**
* Return a value of an attribute with the given XMLTriple.
*
* @param triple an XMLTriple, the XML triple of the attribute whose
* value is required.
*
* @return The attribute value as a string.
*
* @note If an attribute with the given XMLTriple does not exist, an
* empty string will be returned. Use
* XMLAttributes::hasAttribute(const XMLTriple& triple) const to test for attribute existence.
*/
std::string getValue (const XMLTriple& triple) const;
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given index exists in this XMLAttributes.
*
* @param index an integer, the position of the attribute.
*
* @return @c true if an attribute with the given index exists in this
* XMLAttributes, @c false otherwise.
*/
bool hasAttribute (int index) const;
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given local name and namespace URI exists in this
* XMLAttributes.
*
* @param name a string, the local name of the attribute.
* @param uri a string, the namespace URI of the attribute.
*
* @return @c true if an attribute with the given local name and namespace
* URI exists in this XMLAttributes, @c false otherwise.
*/
bool hasAttribute (const std::string name, const std::string uri="") const;
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given XML triple exists in this XMLAttributes.
*
* @param triple an XMLTriple, the XML triple of the attribute
*
* @return @c true if an attribute with the given XML triple exists in this
* XMLAttributes, @c false otherwise.
*
*/
bool hasAttribute (const XMLTriple& triple) const;
/**
* Predicate returning @c true or @c false depending on whether
* this XMLAttributes set is empty.
*
* @return @c true if this XMLAttributes set is empty, @c false otherwise.
*/
bool isEmpty () const;
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as a boolean, value
* is not modified.
*
* According to the W3C XML Schema, valid boolean values are: "true",
* "false", "1", and "0" (case-insensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#boolean
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param name a string, the local name of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. XMLAttributes::readInto(const XMLTriple, bool&, ...) const should
* be used to read a value for an attribute name with a prefix and
* namespace.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const std::string& name
, bool& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given XMLTriple into value.
* If the XMLTriple was not found or value could be interpreted as a boolean,
* value is not modified.
*
* According to the W3C XML Schema, valid boolean values are: "true",
* "false", "1", and "0" (case-insensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#boolean
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const XMLTriple& triple
, bool& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as a double, value is
* not modified.
*
* According to the W3C XML Schema, valid doubles are the same as valid
* doubles for C and the special values "INF", "-INF", and "NaN"
* (case-sensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#double
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param name a string, the local name of the attribute.
* @param value a double, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. XMLAttributes::readInto(const XMLTriple, double&, ...) const
* should be used to read a value for an attribute name with a prefix and
* namespace.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const std::string& name
, double& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given XMLTriple into value.
* If the triple was not found or value could be interpreted as a double,
*value is not modified.
*
* According to the W3C XML Schema, valid doubles are the same as valid
* doubles for C and the special values "INF", "-INF", and "NaN"
* (case-sensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#double
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value a double, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const XMLTriple& triple
, double& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as an long, value is
* not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a long. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param name a string, the local name of the attribute.
* @param value a long, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. XMLAttributes::readInto(const XMLTriple, long&, ...) const should
* be used to read a value for an attribute name with a prefix and
* namespace.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const std::string& name
, long& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute XMLTriple into value.
* If the XMLTriple was not found or value could be interpreted as a long,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a long. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value a long, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const XMLTriple& triple
, long& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as an int, value is
* not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a int. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param name a string, the local name of the attribute.
* @param value an integer, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. XMLAttributes::readInto(const XMLTriple, int&, ...) const should
* be used to read a value for an attribute name with a prefix and
* namespace.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const std::string& name
, int& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given XMLTriple into value.
* If the XMLTriple was not found or value could be interpreted as an int,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a int. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value an integer, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const XMLTriple& triple
, int& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as an unsigned int,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a unsigned int. For more
* information, see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param name a string, the local name of the attribute.
* @param value an unsigned integer, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. XMLAttributes::readInto(const XMLTriple, unsigned int&,
* ...) const should be used to read a value for an attribute name with a
* prefix and namespace.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const std::string& name
, unsigned int& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given XMLTriple into value.
* If the XMLTriple was not found or value could be interpreted as an unsigned int,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a unsigned int. For more
* information, see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value an unsigned integer, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const XMLTriple& triple
, unsigned int& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute name into value. If the given local
* name was not found, value is not modified.
*
* If an XMLErrorLog is passed in and required is true, missing
* attributes are logged.
*
* @param name a string, the local name of the attribute.
* @param value a string, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. XMLAttributes::readInto(const XMLTriple, std::string&, ...) const
* should be used to read a value for an attribute name with a prefix and
* namespace.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const std::string& name
, std::string& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given XMLTriple into value.
* If the XMLTriple was not found, value is not modified.
*
* If an XMLErrorLog is passed in and required is true, missing
* attributes are logged.
*
* @param triple an XMLTriple, the XML triple of the attribute.
* @param value a string, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
bool readInto ( const XMLTriple& triple
, std::string& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/** @cond doxygenLibsbmlInternal */
/**
* Writes this XMLAttributes set to stream.
*
* @param stream XMLOutputStream, stream to which this XMLAttributes
* set is to be written.
*/
void write (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* (Optional) Sets the log used when logging attributeTypeError() and
* attributeRequired() errors.
*
* @param log the log to use
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int setErrorLog (XMLErrorLog* log);
/** @endcond */
#ifndef SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Inserts this XMLAttributes set into stream.
*
* @param stream XMLOutputStream, stream to which the XMLAttributes
* set is to be written.
* @param attributes XMLAttributes, attributes to be written to stream.
*
* @return the stream with the attributes inserted.
*/
LIBLAX_EXTERN
friend XMLOutputStream&
operator<< (XMLOutputStream& stream, const XMLAttributes& attributes);
/** @endcond */
#endif /* !SWIG */
protected:
/** @cond doxygenLibsbmlInternal */
/**
* Used by attributeTypeError().
*/
enum DataType { Boolean = 0, Double = 1, Integer = 2 };
/**
* Logs an attribute datatype error.
*
* @param name name of the attribute
* @param type the datatype of the attribute value.
* @param log the XMLErrorLog where the error should be logged
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*/
void attributeTypeError ( const std::string& name
, DataType type
, XMLErrorLog* log
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Logs an error indicating a required attribute was missing.
* Used internally.
*
* @param name name of the attribute
* @param log the XMLErrorLog where the error should be logged
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*/
void attributeRequiredError ( const std::string& name
, XMLErrorLog* log
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given index into value.
* If the attribute was not found or value could be interpreted as a boolean,
* value is not modified.
*
* According to the W3C XML Schema, valid boolean values are: "true",
* "false", "1", and "0" (case-insensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#boolean
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param index a int, the index of the attribute.
* @param name a string, the name of the attribute
* (only used for an error message (if error detected))
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*/
bool readInto ( int index
, const std::string& name
, bool& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given index into value.
* If name was not found or value could be interpreted as a double, value
* is not modified.
*
* According to the W3C XML Schema, valid doubles are the same as valid
* doubles for C and the special values "INF", "-INF", and "NaN"
* (case-sensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#double
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param index a int, the index of the attribute.
* @param name a string, the name of the attribute
* (only used for an error message (if error detected))
* @param value a double, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*/
bool readInto ( int index
, const std::string& name
, double& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given index into value.
* If the attribute was not found or value could be interpreted as a long,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a long. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param index a int, the index of the attribute.
* @param name a string, the name of the attribute
* (only used for an error message (if error detected))
* @param value a long, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*/
bool readInto ( int index
, const std::string& name
, long& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given index into value.
* If the attribute was not found or value could be interpreted as an integer,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a int. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param index a int, the index of the attribute.
* @param name a string, the name of the attribute
* (only used for an error message (if error detected))
* @param value an integer, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*/
bool readInto ( int index
, const std::string& name
, int& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given index into value.
* If the attribute was not found or value could be interpreted as an
* unsigned int, value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a unsigned int. For more
* information, see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param index a int, the index of the attribute.
* @param name a string, the name of the attribute
* (only used for an error message (if error detected))
* @param value an unsigned integer, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*/
bool readInto ( int index
, const std::string& name
, unsigned int& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
/**
* Reads the value for the attribute with the given index into value.
* If the attribute was not found, value is not modified.
*
* If an XMLErrorLog is passed in and required is true, missing
* attributes are logged.
*
* @param index a int, the index of the attribute.
* @param name a string, the name of the attribute
* (only used for an error message (if error detected))
* @param value a string, the value of the attribute.
* @param log an XMLErrorLog, the error log.
* @param required a boolean, indicating whether the attribute is required.
* @param line an unsigned int, the line number at which the error occured.
* @param column an unsigned int, the column number at which the error occured.
*
* @returns @c true if the attribute was read into value, @c false otherwise.
*/
bool readInto ( int index
, const std::string& name
, std::string& value
, XMLErrorLog* log = NULL
, bool required = false
, const unsigned int line = 0
, const unsigned int column = 0) const;
std::vector<XMLTriple> mNames;
std::vector<std::string> mValues;
std::string mElementName;
XMLErrorLog* mLog;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Creates a new empty XMLAttributes_t set.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
XMLAttributes_t *
XMLAttributes_create (void);
/**
* Frees the given XMLAttributes_t structure.
*
* @param xa the XMLAttributes_t structure to be freed.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
void
XMLAttributes_free (XMLAttributes_t *xa);
/**
* Creates a deep copy of the given XMLAttributes_t structure.
*
* @param att the XMLAttributes_t structure to be copied
*
* @return a (deep) copy of the given XMLAttributes_t structure.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
XMLAttributes_t *
XMLAttributes_clone (const XMLAttributes_t* att);
/**
* Adds a name/value pair to this XMLAttributes_t structure.
*
* @param xa the XMLAttributes_t structure
* @param name a string, the local name of the attribute.
* @param value a string, the value of the attribute.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @note if local name already exists in this attribute set, its value
* will be replaced.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_add (XMLAttributes_t *xa, const char *name, const char *value);
/**
* Adds a name/value pair to this XMLAttributes_t structure with a
* prefix and URI defining a namespace.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value a string, the value of the attribute.
* @param uri a string, the namespace URI of the attribute.
* @param prefix a string, the prefix of the namespace
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @note if local name with the same namespace URI already exists in this
* attribute set, its value will be replaced.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_addWithNamespace (XMLAttributes_t *xa,
const char *name,
const char *value,
const char* uri,
const char* prefix);
/**
* Adds an attribute with the given XMLtriple/value pair to this XMLAttributes_t structure.
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the triple of the attribute.
* @param value a string, the value of the attribute.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_addWithTriple (XMLAttributes_t *xa, const XMLTriple_t* triple, const char* value);
/**
* Removes an attribute (a name/value pair) from this XMLAttributes_t set.
*
* @param xa the XMLAttributes_t structure.
* @param n an integer the index of the resource to be deleted
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_removeResource (XMLAttributes_t *xa, int n);
/**
* Removes an attribute (a name/value pair) from this XMLAttributes_t set.
*
* @param xa the XMLAttributes_t structure.
* @param n an integer the index of the resource to be deleted
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_remove (XMLAttributes_t *xa, int n);
/**
* Removes an attribute with the given local name from this XMLAttributes_t set.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @note A prefix and namespace URI bound to the local name are set to empty
* in this function.
* XMLAttributes_removeByNS(name,uri) or XMLAttributes_removeByTriple(triple)
* should be used to remove an attribute with the given local name and namespace.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_removeByName (XMLAttributes_t *xa, const char* name);
/**
* Removes an attribute with the given name and namespace URI from this
* XMLAttributes_t set.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute for which the index is required.
* @param uri a string, the namespace URI of the attribute.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_removeByNS (XMLAttributes_t *xa, const char* name, const char* uri);
/**
* Removes an attribute with the given triple from this XMLAttributes_t set.
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute for which
* the index is required.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_removeByTriple (XMLAttributes_t *xa, const XMLTriple_t* triple);
/**
* Clears (deletes) all attributes in this XMLAttributes_t structure.
*
* @param xa the XMLAttributes_t structure.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_clear(XMLAttributes_t *xa);
/**
* Return the index of an attribute with the given name.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute for which the index is required.
*
* @return the index of an attribute with the given local name, or -1 if not present.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_getIndex (const XMLAttributes_t *xa, const char *name);
/**
* Return the index of an attribute with the given name and namespace URI.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute for which the index is required.
* @param uri a string, the namespace URI of the attribute.
*
* @return the index of an attribute with the given local name and namespace URI,
* or -1 if not present.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_getIndexByNS (const XMLAttributes_t *xa, const char *name, const char *uri);
/**
* Return the index of an attribute with the given XML triple.
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute for which
* the index is required.
*
* @return the index of an attribute with the given XMLTriple_t, or -1 if not present.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_getIndexByTriple (const XMLAttributes_t *xa, const XMLTriple_t *triple);
/**
* Return the number of attributes in the set.
*
* @param xa the XMLAttributes_t structure.
*
* @return the number of attributes in this XMLAttributes_t structure.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_getLength (const XMLAttributes_t *xa);
/**
* Return the number of attributes in the set.
*
* @param xa the XMLAttributes_t structure.
*
* @return the number of attributes in this XMLAttributes_t structure.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_getNumAttributes (const XMLAttributes_t *xa);
/**
* Return the local name of an attribute in this XMLAttributes_t structure (by position).
*
* @param xa the XMLAttributes_t structure.
* @param index an integer, the position of the attribute whose name is
* required.
*
* @return the local name of an attribute in this list (by position).
* NULL will be returned if the name is empty.
*
* @note If index
* is out of range, an empty string will be returned.
* Use XMLNamespaces_hasAttribute(...) > 0 to test for attribute existence.
* to test for attribute existence.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
char *
XMLAttributes_getName (const XMLAttributes_t *xa, int index);
/**
* Return the value of an attribute in this XMLAttributes_t structure (by position).
*
* @param xa the XMLAttributes_t structure.
* @param index an integer, the position of the attribute whose value is
* required.
*
* @return the value of an attribute in the list (by position).
* NULL will be returned if the prefix is empty.
*
* @note If index
* is out of range, an empty string will be returned.
* Use XMLNamespaces_hasAttribute(...) > 0 to test for attribute existence.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
char *
XMLAttributes_getPrefix (const XMLAttributes_t *xa, int index);
/**
* Return the namespace URI of an attribute in this XMLAttributes_t structure (by position).
*
* @param xa the XMLAttributes_t structure.
* @param index an integer, the position of the attribute whose namespace URI is
* required.
*
* @return the namespace URI of an attribute in this list (by position).
* NULL will be returned if the URI is empty.
*
* @note If index is out of range, an empty string will be returned. Use
* XMLNamespaces_hasAttribute(...) > 0 to test for attribute existence.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
char *
XMLAttributes_getURI (const XMLAttributes_t *xa, int index);
/**
* Return the value of an attribute in this XMLAttributes_t structure (by position).
*
* @param xa the XMLAttributes_t structure.
* @param index an integer, the position of the attribute whose value is
* required.
*
* @return the value of an attribute in the list (by position).
* NULL will be returned if the value is empty.
*
* @note If index
* is out of range, NULL will be returned.
* Use XMLAttributes_hasAttribute(...) > 0 to test for attribute existence.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
char *
XMLAttributes_getValue (const XMLAttributes_t *xa, int index);
/**
* Return an attribute's value by name.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute whose value is required.
*
* @return The attribute value as a string.
* NULL will be returned if the value is empty.
*
* @note If an attribute with the
* given local name does not exist, NULL will be returned. Use
* XMLAttributes_hasAttributeWithName(...) > 0 to test for attribute existence.
* A namespace bound to the local name is not checked by this function.
* Thus, if there are multiple attributes with the given local name and
* different namespaces, the value of an attribute with the smallest index
* among those attributes will be returned.
* XMLAttributes_getValueByNS(...) or XMLAttributes_getValueByTriple(...)
* should be used to get a value of an attribute with the given local name
* and namespace.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
char *
XMLAttributes_getValueByName (const XMLAttributes_t *xa, const char *name);
/**
* Return a value of an attribute with the given local name and namespace URI.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute whose value is required.
* @param uri a string, the namespace URI of the attribute.
*
* @return The attribute value as a string.
* NULL will be returned if the value is empty.
*
* @note If an attribute with the
* given local name and namespace URI does not exist, an empty string will be
* returned.
* Use XMLAttributes_hasAttributeWithNS(...) to test for attribute existence.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
char *
XMLAttributes_getValueByNS (const XMLAttributes_t *xa, const char* name, const char* uri);
LIBLAX_EXTERN
/**
* Return an attribute's value by XMLTriple.
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute
* whose value is required.
*
* @return The attribute value as a string.
* NULL will be returned if the value is empty.
*
* @note If an attribute with the
* given XMLTriple_t does not exist, NULL will be returned.
* Use XMLAttributes_hasAttributeWithTriple(..) > 0 to test for attribute existence.
* Returned const char* should be freed with safe_free() by the caller.
*
* @memberof XMLAttributes_t
*/
char *
XMLAttributes_getValueByTriple (const XMLAttributes_t *xa, const XMLTriple_t* triple);
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given index exists in this XMLAttributes_t
* structure.
*
* @param xa the XMLAttributes_t structure.
* @param index an integer, the position of the attribute.
*
* @return @c non-zero (true) if an attribute with the given index exists
* in this XMLAttributes_t structure, @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_hasAttribute (const XMLAttributes_t *xa, int index);
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given local name exists in this XMLAttributes_t
* structure.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
*
* @return @c non-zero (true) if an attribute with the given local name
* exists in this XMLAttributes_t structure, @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_hasAttributeWithName (const XMLAttributes_t *xa, const char* name);
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given local name and namespace URI exists in this
* XMLAttributes_t structure.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param uri a string, the namespace URI of the attribute.
*
* @return @c non-zero (true) if an attribute with the given local name
* and namespace URI exists in this XMLAttributes_t structure, @c zero (false)
* otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_hasAttributeWithNS (const XMLAttributes_t *xa, const char* name, const char* uri);
/**
* Predicate returning @c true or @c false depending on whether
* an attribute with the given XMLtriple_t exists in this XMLAttributes_t
* structure.
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
*
* @return @c non-zero (true) if an attribute with the given XMLTriple_t
* exists in this XMLAttributes_t structure, @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_hasAttributeWithTriple (const XMLAttributes_t *xa, const XMLTriple_t* triple);
/**
* Predicate returning @c true or @c false depending on whether
* this XMLAttributes_t structure is empty.
*
* @param xa the XMLAttributes_t structure.
*
* @return @c non-zero (true) if this XMLAttributes_t structure is empty,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_isEmpty (const XMLAttributes_t *xa);
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as a boolean, value is
* not modified.
*
* According to the W3C XML Schema, valid boolean values are: "true",
* "false", "1", and "0" (case-insensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#boolean
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. readIntoBooleanByTriple(...) should be used to read a value for
* an attribute name with a prefix and namespace.
*
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoBoolean (XMLAttributes_t *xa,
const char *name,
int *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute with the given XMLTriple_t into value.
* If the XMLTriple_t was not found or value could be interpreted as a boolean,
* value is not modified.
*
* According to the W3C XML Schema, valid boolean values are: "true",
* "false", "1", and "0" (case-insensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#boolean
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoBooleanByTriple (XMLAttributes_t *xa,
const XMLTriple_t* triple,
int *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as a double, value is
* not modified.
*
* According to the W3C XML Schema, valid doubles are the same as valid
* doubles for C and the special values "INF", "-INF", and "NaN"
* (case-sensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#double
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. readIntoDoubleByTriple(...) should be used to read a value for
* an attribute name with a prefix and namespace.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoDouble (XMLAttributes_t *xa,
const char *name,
double *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute with the given XMLTriple_t into value.
* If the XMLTriple_t was not found or value could be interpreted as a double,
* value is not modified.
*
* According to the W3C XML Schema, valid doubles are the same as valid
* doubles for C and the special values "INF", "-INF", and "NaN"
* (case-sensitive). For more information, see:
* http://www.w3.org/TR/xmlschema-2/#double
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoDoubleByTriple (XMLAttributes_t *xa,
const XMLTriple_t* triple,
double *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as a long, value is not
* modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a long. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. readIntoLongByTriple(...) should be used to read a value for
* an attribute name with a prefix and namespace.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoLong (XMLAttributes_t *xa,
const char *name,
long *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute with the given XMLTriple_t into value.
* If the XMLTriple_t was not found or value could be interpreted as a long,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a long. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoLongByTriple (XMLAttributes_t *xa,
const XMLTriple_t* triple,
long *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as an integer, value
* is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a int. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. readIntoIntByTriple(...) should be used to read a value for
* an attribute name with a prefix and namespace.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoInt (XMLAttributes_t *xa,
const char *name,
int *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute with the given XMLTriple_t into value.
* If the XMLTriple_t was not found or value could be interpreted as an integer,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a int. For more information,
* see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
* @param value a boolean, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoIntByTriple (XMLAttributes_t *xa,
const XMLTriple_t* triple,
int *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute name into value. If the given local
* name was not found or value could be interpreted as an unsigned int,
* value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a unsigned int. For more
* information, see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value an unsigned int, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. readIntoUnsignedIntByTriple(...) should be used to read a value for
* an attribute name with a prefix and namespace.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoUnsignedInt (XMLAttributes_t *xa,
const char *name,
unsigned int *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute with the given XMLTriple_t into value.
* If the XMLTriple_t was not found or value could be interpreted as an unsigned
* integer, value is not modified.
*
* According to the W3C XML Schema valid integers include zero, *all*
* positive and *all* negative whole numbers. For practical purposes, we
* limit values to what can be stored in a unsigned int. For more
* information, see: http://www.w3.org/TR/xmlschema-2/#integer
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
* @param value an unsigned int, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoUnsignedIntByTriple (XMLAttributes_t *xa,
const XMLTriple_t* triple,
unsigned int *value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute name into value. If the given local
* name was not found, value is not modified.
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param name a string, the local name of the attribute.
* @param value a string, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @note A namespace bound to the given local name is not checked by this
* function. readIntoStringByTriple(...) should be used to read a value for
* an attribute name with a prefix and namespace.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoString (XMLAttributes_t *xa,
const char *name,
char **value,
XMLErrorLog_t *log,
int required);
/**
* Reads the value for the attribute with the given XMLTriple_t into value.
* If the XMLTriple_t was not found, value is not modified.
*
* If an XMLErrorLog_t is passed in datatype format errors are logged. If
* required is true, missing attributes are also logged.
*
*
* @param xa the XMLAttributes_t structure.
* @param triple an XMLTriple_t, the XML triple of the attribute.
* @param value a string, the value of the attribute.
* @param log an XMLErrorLog_t, the error log.
* @param required a boolean, indicating whether the attribute is required.
*
* @returns @c non-zero (true) if the attribute was read into value,
* @c zero (false) otherwise.
*
* @memberof XMLAttributes_t
*/
LIBLAX_EXTERN
int
XMLAttributes_readIntoStringByTriple (XMLAttributes_t *xa,
const XMLTriple_t* triple,
char **value,
XMLErrorLog_t *log,
int required);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* XMLAttributes_h */
|