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 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028
|
import OCP.Interface
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.Resource
import OCP.Message
import OCP.NCollection
import OCP.TColStd
import OCP.Standard
import io
import OCP.TCollection
__all__ = [
"Interface_Array1OfFileParameter",
"Interface_Array1OfHAsciiString",
"Interface_BitMap",
"Interface_Category",
"Interface_Check",
"Interface_CheckFailure",
"Interface_CheckIterator",
"Interface_CheckStatus",
"Interface_CheckTool",
"Interface_CopyControl",
"Interface_CopyMap",
"Interface_CopyTool",
"Interface_DataMapOfTransientInteger",
"Interface_DataState",
"Interface_EntityCluster",
"Interface_EntityIterator",
"Interface_EntityList",
"Interface_FileParameter",
"Interface_FileReaderData",
"Interface_FileReaderTool",
"Interface_FloatWriter",
"Interface_GTool",
"Interface_GeneralLib",
"Interface_GeneralModule",
"Interface_GlobalNodeOfGeneralLib",
"Interface_GlobalNodeOfReaderLib",
"Interface_Graph",
"Interface_GraphContent",
"Interface_HArray1OfHAsciiString",
"Interface_HGraph",
"Interface_SequenceOfCheck",
"Interface_IndexedMapOfAsciiString",
"Interface_IntList",
"Interface_IntVal",
"Interface_InterfaceError",
"Interface_InterfaceMismatch",
"Interface_InterfaceModel",
"Interface_LineBuffer",
"Interface_MSG",
"Interface_NodeOfGeneralLib",
"Interface_NodeOfReaderLib",
"Interface_ParamList",
"Interface_ParamSet",
"Interface_ParamType",
"Interface_Protocol",
"Interface_ReaderLib",
"Interface_ReaderModule",
"Interface_ReportEntity",
"Interface_STAT",
"Interface_HSequenceOfCheck",
"Interface_ShareFlags",
"Interface_ShareTool",
"Interface_SignLabel",
"Interface_SignType",
"Interface_TypedValue",
"Interface_Static",
"Interface_UndefinedContent",
"Interface_VectorOfFileParameter",
"Interface_CheckAny",
"Interface_CheckFail",
"Interface_CheckMessage",
"Interface_CheckNoFail",
"Interface_CheckOK",
"Interface_CheckWarning",
"Interface_DataFail",
"Interface_DataWarning",
"Interface_LoadFail",
"Interface_LoadWarning",
"Interface_ParamBinary",
"Interface_ParamEnum",
"Interface_ParamHexa",
"Interface_ParamIdent",
"Interface_ParamInteger",
"Interface_ParamLogical",
"Interface_ParamMisc",
"Interface_ParamReal",
"Interface_ParamSub",
"Interface_ParamText",
"Interface_ParamVoid",
"Interface_StateOK",
"Interface_StateUnknown",
"Interface_StateUnloaded"
]
class Interface_Array1OfFileParameter():
"""
The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.
"""
def Assign(self,theOther : Interface_Array1OfFileParameter) -> Interface_Array1OfFileParameter:
"""
Copies data of theOther array to this. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.
"""
def Init(self,theValue : Interface_FileParameter) -> None:
"""
Initialise the items with theValue
"""
def IsDeletable(self) -> bool:
"""
None
"""
def IsEmpty(self) -> bool:
"""
Return TRUE if array has zero length.
"""
def Length(self) -> int:
"""
Length query (the same)
"""
def Lower(self) -> int:
"""
Lower bound
"""
def Move(self,theOther : Interface_Array1OfFileParameter) -> Interface_Array1OfFileParameter:
"""
None
"""
def Resize(self,theLower : int,theUpper : int,theToCopyData : bool) -> None:
"""
Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.
"""
def SetValue(self,theIndex : int,theItem : Interface_FileParameter) -> None:
"""
Set value
"""
def Size(self) -> int:
"""
Size query
"""
def UpdateLowerBound(self,theLower : int) -> None:
"""
Changes the lowest bound. Do not move data
"""
def UpdateUpperBound(self,theUpper : int) -> None:
"""
Changes the upper bound. Do not move data
"""
def Upper(self) -> int:
"""
Upper bound
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> Interface_FileParameter: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int) -> None: ...
@overload
def __init__(self,theAlloc : Any,theLower : int,theUpper : int) -> None: ...
@overload
def __init__(self,theOther : Interface_Array1OfFileParameter) -> None: ...
def __iter__(self) -> Iterator[Interface_FileParameter]: ...
def __len__(self) -> int: ...
pass
class Interface_Array1OfHAsciiString():
"""
The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.
"""
def Assign(self,theOther : Interface_Array1OfHAsciiString) -> Interface_Array1OfHAsciiString:
"""
Copies data of theOther array to this. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.
"""
def Init(self,theValue : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Initialise the items with theValue
"""
def IsDeletable(self) -> bool:
"""
None
"""
def IsEmpty(self) -> bool:
"""
Return TRUE if array has zero length.
"""
def Length(self) -> int:
"""
Length query (the same)
"""
def Lower(self) -> int:
"""
Lower bound
"""
def Move(self,theOther : Interface_Array1OfHAsciiString) -> Interface_Array1OfHAsciiString:
"""
None
"""
def Resize(self,theLower : int,theUpper : int,theToCopyData : bool) -> None:
"""
Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.
"""
def SetValue(self,theIndex : int,theItem : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Set value
"""
def Size(self) -> int:
"""
Size query
"""
def UpdateLowerBound(self,theLower : int) -> None:
"""
Changes the lowest bound. Do not move data
"""
def UpdateUpperBound(self,theUpper : int) -> None:
"""
Changes the upper bound. Do not move data
"""
def Upper(self) -> int:
"""
Upper bound
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> OCP.TCollection.TCollection_HAsciiString: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theAlloc : Any,theLower : int,theUpper : int) -> None: ...
@overload
def __init__(self,theOther : Interface_Array1OfHAsciiString) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int) -> None: ...
def __iter__(self) -> Iterator[OCP.TCollection.TCollection_HAsciiString]: ...
def __len__(self) -> int: ...
pass
class Interface_BitMap():
"""
A bit map simply allows to associate a boolean flag to each item of a list, such as a list of entities, etc... numbered between 1 and a positive count nbitems
"""
def AddFlag(self,name : str='') -> int:
"""
Adds a flag, a name can be attached to it Returns its flag number Makes required reservation
"""
def AddSomeFlags(self,more : int) -> int:
"""
Adds several flags (<more>) with no name Returns the number of last added flag
"""
def CFalse(self,item : int,flag : int=0) -> bool:
"""
Returns the former value for a flag and sets it to False (before : value returned; after : False)
"""
def CTrue(self,item : int,flag : int=0) -> bool:
"""
Returns the former value for a flag and sets it to True (before : value returned; after : True)
"""
def Clear(self) -> None:
"""
Clear all field of bit map
"""
def FlagName(self,num : int) -> str:
"""
Returns the name recorded for a flag, or an empty string
"""
def FlagNumber(self,name : str) -> int:
"""
Returns the number or a flag given its name, or zero
"""
def Init(self,val : bool,flag : int=0) -> None:
"""
Initialises all the values of Flag Number <flag> to a given value <val>
"""
@overload
def Initialize(self,other : Interface_BitMap,copied : bool=False) -> None:
"""
Initialize empty bit by <nbitems> items One flag is defined, n0 0 <resflags> prepares allocation for <resflags> more flags Flags values start at false
Initialize a BitMap from another one
"""
@overload
def Initialize(self,nbitems : int,resflags : int=0) -> None: ...
def Length(self) -> int:
"""
Returns the count of items (i.e. the length of the bitmap)
"""
def NbFlags(self) -> int:
"""
Returns the count of flags (flag 0 not included)
"""
def RemoveFlag(self,num : int) -> bool:
"""
Removes a flag given its number. Returns True if done, false if num is out of range
"""
def Reservate(self,moreflags : int) -> None:
"""
Reservates for a count of more flags
"""
def SetFalse(self,item : int,flag : int=0) -> None:
"""
Sets a flag to False
"""
def SetFlagName(self,num : int,name : str) -> bool:
"""
Sets a name for a flag, given its number name can be empty (to erase the name of a flag) Returns True if done, false if : num is out of range, or name non-empty already set to another flag
"""
def SetLength(self,nbitems : int) -> None:
"""
Sets for a new count of items, which can be either less or greater than the former one For new items, their flags start at false
"""
def SetTrue(self,item : int,flag : int=0) -> None:
"""
Sets a flag to True
"""
def SetValue(self,item : int,val : bool,flag : int=0) -> None:
"""
Sets a new value for a flag
"""
def Value(self,item : int,flag : int=0) -> bool:
"""
Returns the value (true/false) of a flag, from : - the number of the item - the flag number, by default 0
"""
@overload
def __init__(self,other : Interface_BitMap,copied : bool=False) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,nbitems : int,resflags : int=0) -> None: ...
pass
class Interface_Category():
"""
This class manages categories A category is defined by a name and a number, and can be seen as a way of rough classification, i.e. less precise than a cdl type. Hence, it is possible to dispatch every entity in about a dozen of categories, twenty is a reasonable maximum.
"""
@staticmethod
def AddCategory_s(theName : str) -> int:
"""
Records a new Category defined by its names, produces a number New if not yet recorded
"""
def CatNum(self,theEnt : OCP.Standard.Standard_Transient,theShares : Interface_ShareTool) -> int:
"""
Determines the Category Number for an entity in its context, by using general service CategoryNumber
"""
def ClearNums(self) -> None:
"""
Clears the recorded list of category numbers for a Model
"""
def Compute(self,theModel : Interface_InterfaceModel,theShares : Interface_ShareTool) -> None:
"""
Computes the Category Number for each entity and records it, in an array (ent.number -> category number) Hence, it can be queried by the method Num. The Model itself is not recorded, this method is intended to be used in a wider context (which detains also a Graph, etc)
"""
@staticmethod
def Init_s() -> None:
"""
Default initialisation (protected against several calls : passes only once)
"""
@staticmethod
def Name_s(theNum : int) -> str:
"""
Returns the name of a category, according to its number
"""
@staticmethod
def NbCategories_s() -> int:
"""
Returns the count of recorded categories
"""
def Num(self,theNumEnt : int) -> int:
"""
Returns the category number recorded for an entity number Returns 0 if out of range
"""
@staticmethod
def Number_s(theName : str) -> int:
"""
Returns the number of a category, according to its name
"""
def SetProtocol(self,theProtocol : Interface_Protocol) -> None:
"""
Sets/Changes Protocol
"""
@overload
def __init__(self,theGTool : Interface_GTool) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theProtocol : Interface_Protocol) -> None: ...
pass
class Interface_Check(OCP.Standard.Standard_Transient):
"""
Defines a Check, as a list of Fail or Warning Messages under a literal form, which can be empty. A Check can also bring an Entity, which is the Entity to which the messages apply (this Entity may be any Transient Object).Defines a Check, as a list of Fail or Warning Messages under a literal form, which can be empty. A Check can also bring an Entity, which is the Entity to which the messages apply (this Entity may be any Transient Object).Defines a Check, as a list of Fail or Warning Messages under a literal form, which can be empty. A Check can also bring an Entity, which is the Entity to which the messages apply (this Entity may be any Transient Object).
"""
@overload
def AddFail(self,amess : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Records a new Fail message
Records a new Fail message under two forms : final,original
Records a new Fail message given as "error text" directly If <orig> is given, a distinct original form is recorded else (D), the original form equates <amess>
Records a new Fail from the definition of a Msg (Original+Value)
"""
@overload
def AddFail(self,amess : str,orig : str='') -> None: ...
@overload
def AddFail(self,amess : OCP.TCollection.TCollection_HAsciiString,orig : OCP.TCollection.TCollection_HAsciiString) -> None: ...
@overload
def AddFail(self,amsg : OCP.Message.Message_Msg) -> None: ...
@overload
def AddWarning(self,amess : OCP.TCollection.TCollection_HAsciiString,orig : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Records a new Warning message
Records a new Warning message under two forms : final,original
Records a Warning message given as "warning message" directly If <orig> is given, a distinct original form is recorded else (D), the original form equates <amess>
Records a new Warning from the definition of a Msg (Original+Value)
"""
@overload
def AddWarning(self,amsg : OCP.Message.Message_Msg) -> None: ...
@overload
def AddWarning(self,amess : OCP.TCollection.TCollection_HAsciiString) -> None: ...
@overload
def AddWarning(self,amess : str,orig : str='') -> None: ...
def CFail(self,num : int,final : bool=True) -> str:
"""
Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False
"""
def CInfoMsg(self,num : int,final : bool=True) -> str:
"""
Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False
"""
def CWarning(self,num : int,final : bool=True) -> str:
"""
Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False
"""
def Clear(self) -> None:
"""
Clears a check, in order to receive information from transfer (Messages and Entity)
"""
def ClearFails(self) -> None:
"""
Clears the Fail Messages (for instance to keep only Warnings)
"""
def ClearInfoMsgs(self) -> None:
"""
Clears the Info Messages
"""
def ClearWarnings(self) -> None:
"""
Clears the Warning Messages (for instance to keep only Fails)
"""
@overload
def Complies(self,mess : OCP.TCollection.TCollection_HAsciiString,incl : int,status : Interface_CheckStatus) -> bool:
"""
Tells if Check Status complies with a given one (i.e. also status for query)
Tells if a message is brought by a Check, as follows : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (answer will be false)
"""
@overload
def Complies(self,status : Interface_CheckStatus) -> bool: ...
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Entity(self) -> OCP.Standard.Standard_Transient:
"""
Returns the entity on which the Check has been defined
"""
def Fail(self,num : int,final : bool=True) -> OCP.TCollection.TCollection_HAsciiString:
"""
Returns Fail Message as a String Final form by default, Original form if <final> is False
"""
def Fails(self,final : bool=True) -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns the list of Fails, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty
"""
def GetAsWarning(self,other : Interface_Check,failsonly : bool) -> None:
"""
Copies messages converted into Warning messages If failsonly is true, only Fails are taken, and converted else, Warnings are taken too. Does not regard Entity Used to keep Fail messages as Warning, after a recovery
"""
def GetEntity(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
same as SetEntity (old form kept for compatibility) Warning : Does nothing if Entity field is not yet clear
"""
def GetMessages(self,other : Interface_Check) -> None:
"""
Copies messages stored in another Check, cumulating Does not regard other's Entity. Used to cumulate messages
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def HasEntity(self) -> bool:
"""
Returns True if a Check is devoted to an entity; else, it is global (for InterfaceModel's storing of global error messages)
"""
def HasFailed(self) -> bool:
"""
Returns True if Check brings at least one Fail Message
"""
def HasWarnings(self) -> bool:
"""
Returns True if Check brings at least one Warning Message
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def InfoMsg(self,num : int,final : bool=True) -> OCP.TCollection.TCollection_HAsciiString:
"""
Returns information message as a String
"""
def InfoMsgs(self,final : bool=True) -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns the list of Info Msg, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Mend(self,pref : str,num : int=0) -> bool:
"""
Mends messages, according <pref> and <num> According to <num>, works on the whole list of Fails if = 0(D) or only one Fail message, given its rank If <pref> is empty, converts Fail(s) to Warning(s) Else, does the conversion but prefixes the new Warning(s) but <pref> followed by a semi-column Some reserved values of <pref> are : "FM" : standard prefix "Mended" (can be translated) "CF" : clears Fail(s) "CW" : clears Warning(s) : here, <num> refers to Warning list "CA" : clears all messages : here, <num> is ignored
"""
def NbFails(self) -> int:
"""
Returns count of recorded Fails
"""
def NbInfoMsgs(self) -> int:
"""
Returns the count of recorded information messages
"""
def NbWarnings(self) -> int:
"""
Returns count of recorded Warning messages
"""
def Print(self,S : io.BytesIO,level : int,final : int=1) -> None:
"""
Prints the messages of the check to an Messenger <level> = 1 : only fails <level> = 2 : fails and warnings <level> = 3 : all (fails, warnings, info msg) <final> : if positive (D) prints final values of messages if negative, prints originals if null, prints both forms
"""
def Remove(self,mess : OCP.TCollection.TCollection_HAsciiString,incl : int,status : Interface_CheckStatus) -> bool:
"""
Removes the messages which comply with <mess>, as follows : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (nothing is done) Returns True if at least one message has been removed, False else
"""
def SendFail(self,amsg : OCP.Message.Message_Msg) -> None:
"""
New name for AddFail (Msg)
"""
def SendMsg(self,amsg : OCP.Message.Message_Msg) -> None:
"""
Records an information message This does not change the status of the Check
"""
def SendWarning(self,amsg : OCP.Message.Message_Msg) -> None:
"""
New name for AddWarning
"""
def SetEntity(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
Receives an entity result of a Transfer
"""
def Status(self) -> Interface_CheckStatus:
"""
Returns the Check Status : OK, Warning or Fail
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Trace(self,level : int=-1,final : int=1) -> None:
"""
Prints the messages of the check to the default trace file By default, according to the default standard level Else, according level (see method Print)
"""
def Warning(self,num : int,final : bool=True) -> OCP.TCollection.TCollection_HAsciiString:
"""
Returns Warning message as a String Final form by default, Original form if <final> is False
"""
def Warnings(self,final : bool=True) -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns the list of Warnings, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty
"""
@overload
def __init__(self,anentity : OCP.Standard.Standard_Transient) -> None: ...
@overload
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_CheckFailure(Exception, BaseException):
class type():
pass
__cause__: getset_descriptor # value = <attribute '__cause__' of 'BaseException' objects>
__context__: getset_descriptor # value = <attribute '__context__' of 'BaseException' objects>
__dict__: mappingproxy # value = mappingproxy({'__module__': 'OCP.Interface', '__weakref__': <attribute '__weakref__' of 'Interface_CheckFailure' objects>, '__doc__': None})
__suppress_context__: member_descriptor # value = <member '__suppress_context__' of 'BaseException' objects>
__traceback__: getset_descriptor # value = <attribute '__traceback__' of 'BaseException' objects>
__weakref__: getset_descriptor # value = <attribute '__weakref__' of 'Interface_CheckFailure' objects>
args: getset_descriptor # value = <attribute 'args' of 'BaseException' objects>
pass
class Interface_CheckIterator():
"""
Result of a Check operation (especially from InterfaceModel)
"""
def Add(self,ach : Interface_Check,num : int=0) -> None:
"""
Adds a Check to the list to be iterated This Check is Accompanied by Entity Number in the Model (0 for Global Check or Entity unknown in the Model), if 0 and Model is recorded in <me>, it is computed
"""
@overload
def CCheck(self,ent : OCP.Standard.Standard_Transient) -> Interface_Check:
"""
Returns the Check bound to an Entity Number (0 : Global) in order to be consulted or completed on the spot I.e. returns the Check if is already exists, or adds it then returns the new empty Check
Returns the Check bound to an Entity, in order to be consulted or completed on the spot I.e. returns the Check if is already exists, or adds it then returns the new empty Check
"""
@overload
def CCheck(self,num : int) -> Interface_Check: ...
@overload
def Check(self,num : int) -> Interface_Check:
"""
Returns the Check which was attached to an Entity given its Number in the Model. <num>=0 is for the Global Check. If no Check was recorded for this Number, returns an empty Check. Remark : Works apart from the iteration methods (no interference)
Returns the Check attached to an Entity If no Check was recorded for this Entity, returns an empty Check. Remark : Works apart from the iteration methods (no interference)
"""
@overload
def Check(self,ent : OCP.Standard.Standard_Transient) -> Interface_Check: ...
def Checkeds(self,failsonly : bool,global_ : bool) -> OCP.TColStd.TColStd_HSequenceOfTransient:
"""
Returns the list of entities concerned by a Check Only fails if <failsonly> is True, else all non-empty checks If <global> is true, adds the model for a global check Else, global check is ignored
"""
def Clear(self) -> None:
"""
Clears the list of checks
"""
def Complies(self,status : Interface_CheckStatus) -> bool:
"""
Tells if this check list complies with a given status : OK (i.e. empty), Warning (at least one Warning, but no Fail), Fail (at least one), Message (not OK), NoFail, Any
"""
def Destroy(self) -> None:
"""
Clears data of iteration
"""
@overload
def Extract(self,status : Interface_CheckStatus) -> Interface_CheckIterator:
"""
Returns a CheckIterator which contains the checks which comply with a given status Each check is added completely (no split Warning/Fail)
Returns a CheckIterator which contains the check which comply with a message, plus some conditions as follows : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (answer will be false) Each Check which complies is entirely taken
"""
@overload
def Extract(self,mess : str,incl : int,status : Interface_CheckStatus) -> Interface_CheckIterator: ...
def IsEmpty(self,failsonly : bool) -> bool:
"""
Returns True if : no Fail has been recorded if <failsonly> is True, no Check at all if <failsonly> is False
"""
def Merge(self,other : Interface_CheckIterator) -> None:
"""
Merges another CheckIterator into <me>, i.e. adds each of its Checks. Content of <other> remains unchanged. Takes also the Model but not the Name
"""
def Model(self) -> Interface_InterfaceModel:
"""
Returns the stored model (can be a null handle)
"""
def More(self) -> bool:
"""
Returns True if there are more Checks to get
"""
def Name(self) -> str:
"""
Returns the recorded name (can be empty)
"""
def Next(self) -> None:
"""
Sets Iteration to next Item
"""
def Number(self) -> int:
"""
Returns Number of Entity for the Check currently iterated or 0 for GlobalCheck
"""
@overload
def Print(self,S : io.BytesIO,model : Interface_InterfaceModel,failsonly : bool,final : int=0) -> None:
"""
Prints the list of Checks with their attached Numbers If <failsonly> is True, prints only Fail messages If <failsonly> is False, prints all messages If <final> = 0 (D), prints also original messages if different If <final> < 0, prints only original messages If <final> > 0, prints only final messages It uses the recorded Model if it is defined Remark : Works apart from the iteration methods (no interference)
Works as Print without a model, but for entities which have no attached number (Number not positive), tries to compute this Number from <model> and displays "original" or "computed"
"""
@overload
def Print(self,S : io.BytesIO,failsonly : bool,final : int=0) -> None: ...
def Remove(self,mess : str,incl : int,status : Interface_CheckStatus) -> bool:
"""
Removes the messages of all Checks, under these conditions : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (nothing is done) Returns True if at least one message has been removed, False else
"""
def SetModel(self,model : Interface_InterfaceModel) -> None:
"""
Defines a Model, used to locate entities (not required, if it is absent, entities are simply less documented)
"""
def SetName(self,name : str) -> None:
"""
Sets / Changes the name
"""
def Start(self) -> None:
"""
Starts Iteration. Thus, it is possible to restart it Remark : an iteration may be done with a const Iterator While its content is modified (through a pointer), this allows to give it as a const argument to a function
"""
def Status(self) -> Interface_CheckStatus:
"""
Returns worst status among : OK, Warning, Fail
"""
def Value(self) -> Interface_Check:
"""
Returns Check currently Iterated It brings all other information (status, messages, ...) The Number of the Entity in the Model is given by Number below
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,name : str) -> None: ...
pass
class Interface_CheckStatus():
"""
Classifies checks OK : check is empty Warning : Warning, no Fail Fail : Fail Others to query : Any : any status Message : Warning/Fail NoFail : Warning/OK
Members:
Interface_CheckOK
Interface_CheckWarning
Interface_CheckFail
Interface_CheckAny
Interface_CheckMessage
Interface_CheckNoFail
"""
def __eq__(self,other : object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self,value : int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self,other : object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self,state : int) -> None: ...
def __str__(self) -> str: ...
@property
def name(self) -> None:
"""
:type: None
"""
@property
def value(self) -> int:
"""
:type: int
"""
Interface_CheckAny: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckAny: 3>
Interface_CheckFail: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckFail: 2>
Interface_CheckMessage: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckMessage: 4>
Interface_CheckNoFail: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckNoFail: 5>
Interface_CheckOK: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckOK: 0>
Interface_CheckWarning: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckWarning: 1>
__entries: dict # value = {'Interface_CheckOK': (<Interface_CheckStatus.Interface_CheckOK: 0>, None), 'Interface_CheckWarning': (<Interface_CheckStatus.Interface_CheckWarning: 1>, None), 'Interface_CheckFail': (<Interface_CheckStatus.Interface_CheckFail: 2>, None), 'Interface_CheckAny': (<Interface_CheckStatus.Interface_CheckAny: 3>, None), 'Interface_CheckMessage': (<Interface_CheckStatus.Interface_CheckMessage: 4>, None), 'Interface_CheckNoFail': (<Interface_CheckStatus.Interface_CheckNoFail: 5>, None)}
__members__: dict # value = {'Interface_CheckOK': <Interface_CheckStatus.Interface_CheckOK: 0>, 'Interface_CheckWarning': <Interface_CheckStatus.Interface_CheckWarning: 1>, 'Interface_CheckFail': <Interface_CheckStatus.Interface_CheckFail: 2>, 'Interface_CheckAny': <Interface_CheckStatus.Interface_CheckAny: 3>, 'Interface_CheckMessage': <Interface_CheckStatus.Interface_CheckMessage: 4>, 'Interface_CheckNoFail': <Interface_CheckStatus.Interface_CheckNoFail: 5>}
pass
class Interface_CheckTool():
"""
Performs Checks on Entities, using General Service Library and Modules to work. Works on one Entity or on a complete Model
"""
def AnalyseCheckList(self) -> Interface_CheckIterator:
"""
Returns list of errors detected at Analyse time (syntactic) (note that GlobalCheck is not in this list)
"""
def Check(self,num : int) -> Interface_Check:
"""
Returns the Check associated to an Entity identified by its Number in a Model.
"""
def CheckList(self) -> Interface_CheckIterator:
"""
Returns list of all Errors detected Note that presence of Unknown Entities is not an error Cumulates : GlobalCheck if error + AnalyseCheckList + VerifyCheckList
"""
def CheckSuccess(self,reset : bool=False) -> None:
"""
Checks if any Error has been detected (CheckList not empty) Returns normally if none, raises exception if some exists. It reuses the last computations from other checking methods, unless the argument <reset> is given True
"""
def CompleteCheckList(self) -> Interface_CheckIterator:
"""
Returns list of all "remarkable" information, which include : - GlobalCheck, if not empty - Error Checks, for all Errors (Verify + Analyse) - also Corrected Entities - and Unknown Entities : for those, each Unknown Entity is associated to an empty Check (it is neither an Error nor a Correction, but a remarkable information)
"""
def FillCheck(self,ent : OCP.Standard.Standard_Transient,sh : Interface_ShareTool,ach : Interface_Check) -> Any:
"""
Fills as required a Check with the Error and Warning messages produced by Checking a given Entity. For an Erroneous or Corrected Entity : Check build at Analyse time; else, Check computed for Entity (Verify integrity), can use a Graph as required to control context
"""
@overload
def Print(self,ach : Interface_Check,S : io.BytesIO) -> None:
"""
Utility method which Prints the content of a Check
Simply Lists all the Checks and the Content (messages) and the Entity, if there is, of each Check (if all Checks are OK, nothing is Printed)
"""
@overload
def Print(self,list : Interface_CheckIterator,S : io.BytesIO) -> None: ...
def UnknownEntities(self) -> Interface_EntityIterator:
"""
Returns list of Unknown Entities Note that Error and Erroneous Entities are not considered as Unknown
"""
def VerifyCheckList(self) -> Interface_CheckIterator:
"""
Returns list of integrity constraints errors (semantic) (note that GlobalCheck is not in this list)
"""
def WarningCheckList(self) -> Interface_CheckIterator:
"""
Returns list of Corrections (includes GlobalCheck if corrected)
"""
@overload
def __init__(self,model : Interface_InterfaceModel) -> None: ...
@overload
def __init__(self,hgraph : Interface_HGraph) -> None: ...
@overload
def __init__(self,graph : Interface_Graph) -> None: ...
@overload
def __init__(self,model : Interface_InterfaceModel,protocol : Interface_Protocol) -> None: ...
pass
class Interface_CopyControl(OCP.Standard.Standard_Transient):
"""
This deferred class describes the services required by CopyTool to work. They are very simple and correspond basically to the management of an indexed map. But they can be provided by various classes which can control a Transfer. Each Starting Entity have at most one Result (Mapping one-one)This deferred class describes the services required by CopyTool to work. They are very simple and correspond basically to the management of an indexed map. But they can be provided by various classes which can control a Transfer. Each Starting Entity have at most one Result (Mapping one-one)This deferred class describes the services required by CopyTool to work. They are very simple and correspond basically to the management of an indexed map. But they can be provided by various classes which can control a Transfer. Each Starting Entity have at most one Result (Mapping one-one)
"""
def Bind(self,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> None:
"""
Bind a Result to a Starting Entity identified by its Number
"""
def Clear(self) -> None:
"""
Clears List of Copy Results. Gets Ready to begin another Copy Process.
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Search(self,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> bool:
"""
Searches for the Result bound to a Startingf Entity identified by its Number. If Found, returns True and fills <res> Else, returns False and nullifies <res>
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_CopyMap(Interface_CopyControl, OCP.Standard.Standard_Transient):
"""
Manages a Map for the need of single Transfers, such as Copies In such transfer, Starting Entities are read from a unique Starting Model, and each transferred Entity is bound to one and only one Result, which cannot be changed later.Manages a Map for the need of single Transfers, such as Copies In such transfer, Starting Entities are read from a unique Starting Model, and each transferred Entity is bound to one and only one Result, which cannot be changed later.Manages a Map for the need of single Transfers, such as Copies In such transfer, Starting Entities are read from a unique Starting Model, and each transferred Entity is bound to one and only one Result, which cannot be changed later.
"""
def Bind(self,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> None:
"""
Binds a Starting Entity identified by its Number <num> in the Starting Model, to a Result of Transfer <res>
"""
def Clear(self) -> None:
"""
Clears Transfer List. Gets Ready to begin another Transfer
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Model(self) -> Interface_InterfaceModel:
"""
Returns the InterfaceModel used at Creation time
"""
def Search(self,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> bool:
"""
Search for the result of a Starting Object (i.e. an Entity, identified by its Number <num> in the Starting Model) Returns True if a Result is Bound (and fills <res>) Returns False if no result is Bound (and nullifies <res>)
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self,amodel : Interface_InterfaceModel) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_CopyTool():
"""
Performs Deep Copies of sets of Entities Allows to perform Copy of Interface Entities from a Model to another one. Works by calling general services GetFromAnother and GetImplied. Uses a CopyMap to bind a unique Result to each Copied Entity
"""
def Bind(self,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> None:
"""
Defines a Result for the Transfer of a Starting object. Used by method Transferred (which performs a normal Copy), but can also be called to enforce a result : in the latter case, the enforced result must be compatible with the other Transfers which are performed
"""
def Clear(self) -> None:
"""
Clears Transfer List. Gets Ready to begin another Transfer
"""
def ClearLastFlags(self) -> None:
"""
Clears LastFlags only. This allows to know what Entities are copied after its call (see method LastCopiedAfter). It can be used when copies are done by increments, which must be distinghished. ClearLastFlags is also called by Clear.
"""
def CompleteResult(self,withreports : bool=False) -> Interface_EntityIterator:
"""
Returns the complete list of copied Entities If <withreports> is given True, the entities which were reported in the Starting Model are replaced in the list by the copied ReportEntities
"""
def Control(self) -> Interface_CopyControl:
"""
Returns the object used for Control
"""
def Copy(self,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,mapped : bool,errstat : bool) -> bool:
"""
Creates the CounterPart of an Entity (by ShallowCopy), Binds it, then Copies the content of the former Entity to the other one (same Type), by call to the General Service Library It may command the Copy of Referenced Entities Then, its returns True.
"""
def FillModel(self,bmodel : Interface_InterfaceModel) -> None:
"""
Fills a Model with the result of the transfer (TransferList) Commands copy of Header too, and calls RenewImpliedRefs
"""
def LastCopiedAfter(self,numfrom : int,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> int:
"""
Returns an copied Entity and its Result which were operated after last call to ClearLastFlags. It returns the first "Last Copied Entity" which Number follows <numfrom>, Zero if none. It is used in a loop as follow : Integer num = 0; while ( (num = CopyTool.LastCopiedAfter(num,ent,res)) ) { .. Process Starting <ent> and its Result <res> }
"""
def Model(self) -> Interface_InterfaceModel:
"""
Returns the Model on which the CopyTool works
"""
def RenewImpliedRefs(self) -> None:
"""
Renews the Implied References. These References do not involve Copying of referenced Entities. For such a Reference, if the Entity which defines it AND the referenced Entity are both copied, then this Reference is renewed. Else it is deleted in the copied Entities. Remark : this concerns only some specific references, such as "back pointers".
"""
def RootResult(self,withreports : bool=False) -> Interface_EntityIterator:
"""
Returns the list of Root copied Entities (those which were asked for copy by the user of CopyTool, not by copying another Entity)
"""
def Search(self,ent : OCP.Standard.Standard_Transient,res : OCP.Standard.Standard_Transient) -> bool:
"""
Search for the result of a Starting Object (i.e. an Entity) Returns True if a Result is Bound (and fills "result") Returns False if no result is Bound
"""
def SetControl(self,othermap : Interface_CopyControl) -> None:
"""
Changes the Map of Result for another one. This allows to work with a more sophisticated Mapping Control than the Standard one which is CopyMap (e.g. TransferProcess from Transfer)
"""
def TransferEntity(self,ent : OCP.Standard.Standard_Transient) -> None:
"""
Transfers one Entity and records result into the Transfer List Calls method Transferred
"""
def Transferred(self,ent : OCP.Standard.Standard_Transient) -> OCP.Standard.Standard_Transient:
"""
Transfers one Entity, if not yet bound to a result Remark : For an Entity which is reported in the Starting Model, the ReportEntity will also be copied with its Content if it has one (at least ShallowCopy; Complete Copy if the Protocol recognizes the Content : see method Copy)
"""
@overload
def __init__(self,amodel : Interface_InterfaceModel,protocol : Interface_Protocol) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,lib : Interface_GeneralLib) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel) -> None: ...
pass
class Interface_DataMapOfTransientInteger(OCP.NCollection.NCollection_BaseMap):
"""
Purpose: The DataMap is a Map to store keys with associated Items. See Map from NCollection for a discussion about the number of buckets.
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
def Assign(self,theOther : Interface_DataMapOfTransientInteger) -> Interface_DataMapOfTransientInteger:
"""
Assignment. This method does not change the internal allocator.
"""
def Bind(self,theKey : OCP.Standard.Standard_Transient,theItem : int) -> bool:
"""
Bind binds Item to Key in map.
"""
def Bound(self,theKey : OCP.Standard.Standard_Transient,theItem : int) -> int:
"""
Bound binds Item to Key in map.
"""
def ChangeFind(self,theKey : OCP.Standard.Standard_Transient) -> int:
"""
ChangeFind returns mofifiable Item by Key. Raises if Key was not bound
"""
def ChangeSeek(self,theKey : OCP.Standard.Standard_Transient) -> int:
"""
ChangeSeek returns modifiable pointer to Item by Key. Returns NULL is Key was not bound.
"""
@overload
def Clear(self,doReleaseMemory : bool=False) -> None:
"""
Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.
Clear data and reset allocator
"""
@overload
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator) -> None: ...
def Exchange(self,theOther : Interface_DataMapOfTransientInteger) -> None:
"""
Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!
"""
def Extent(self) -> int:
"""
Extent
"""
@overload
def Find(self,theKey : OCP.Standard.Standard_Transient) -> int:
"""
Find returns the Item for Key. Raises if Key was not bound
Find Item for key with copying.
"""
@overload
def Find(self,theKey : OCP.Standard.Standard_Transient,theValue : int) -> bool: ...
def IsBound(self,theKey : OCP.Standard.Standard_Transient) -> bool:
"""
IsBound
"""
def IsEmpty(self) -> bool:
"""
IsEmpty
"""
def NbBuckets(self) -> int:
"""
NbBuckets
"""
def ReSize(self,N : int) -> None:
"""
ReSize
"""
def Seek(self,theKey : OCP.Standard.Standard_Transient) -> int:
"""
Seek returns pointer to Item by Key. Returns NULL is Key was not bound.
"""
def Size(self) -> int:
"""
Size
"""
def Statistics(self,S : io.BytesIO) -> None:
"""
Statistics
"""
def UnBind(self,theKey : OCP.Standard.Standard_Transient) -> bool:
"""
UnBind removes Item Key pair from map
"""
def __call__(self,theKey : OCP.Standard.Standard_Transient) -> int: ...
@overload
def __init__(self,theNbBuckets : int,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theOther : Interface_DataMapOfTransientInteger) -> None: ...
def __iter__(self) -> Iterator[int]: ...
def __len__(self) -> int: ...
pass
class Interface_DataState():
"""
validity state of anentity's content (see InterfaceModel)
Members:
Interface_StateOK
Interface_LoadWarning
Interface_LoadFail
Interface_DataWarning
Interface_DataFail
Interface_StateUnloaded
Interface_StateUnknown
"""
def __eq__(self,other : object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self,value : int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self,other : object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self,state : int) -> None: ...
def __str__(self) -> str: ...
@property
def name(self) -> None:
"""
:type: None
"""
@property
def value(self) -> int:
"""
:type: int
"""
Interface_DataFail: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_DataFail: 4>
Interface_DataWarning: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_DataWarning: 3>
Interface_LoadFail: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_LoadFail: 2>
Interface_LoadWarning: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_LoadWarning: 1>
Interface_StateOK: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_StateOK: 0>
Interface_StateUnknown: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_StateUnknown: 6>
Interface_StateUnloaded: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_StateUnloaded: 5>
__entries: dict # value = {'Interface_StateOK': (<Interface_DataState.Interface_StateOK: 0>, None), 'Interface_LoadWarning': (<Interface_DataState.Interface_LoadWarning: 1>, None), 'Interface_LoadFail': (<Interface_DataState.Interface_LoadFail: 2>, None), 'Interface_DataWarning': (<Interface_DataState.Interface_DataWarning: 3>, None), 'Interface_DataFail': (<Interface_DataState.Interface_DataFail: 4>, None), 'Interface_StateUnloaded': (<Interface_DataState.Interface_StateUnloaded: 5>, None), 'Interface_StateUnknown': (<Interface_DataState.Interface_StateUnknown: 6>, None)}
__members__: dict # value = {'Interface_StateOK': <Interface_DataState.Interface_StateOK: 0>, 'Interface_LoadWarning': <Interface_DataState.Interface_LoadWarning: 1>, 'Interface_LoadFail': <Interface_DataState.Interface_LoadFail: 2>, 'Interface_DataWarning': <Interface_DataState.Interface_DataWarning: 3>, 'Interface_DataFail': <Interface_DataState.Interface_DataFail: 4>, 'Interface_StateUnloaded': <Interface_DataState.Interface_StateUnloaded: 5>, 'Interface_StateUnknown': <Interface_DataState.Interface_StateUnknown: 6>}
pass
class Interface_EntityCluster(OCP.Standard.Standard_Transient):
"""
Auxiliary class for EntityList. An EntityList designates an EntityCluster, which brings itself an fixed maximum count of Entities. If it is full, it gives access to another cluster ("Next"). This class is intended to give a good compromise between access time (faster than a Sequence, good for little count) and memory use (better than a Sequence in any case, overall for little count, better than an Array for a very little count. It is designed for a light management. Remark that a new Item may not be Null, because this is the criterium used for "End of List"Auxiliary class for EntityList. An EntityList designates an EntityCluster, which brings itself an fixed maximum count of Entities. If it is full, it gives access to another cluster ("Next"). This class is intended to give a good compromise between access time (faster than a Sequence, good for little count) and memory use (better than a Sequence in any case, overall for little count, better than an Array for a very little count. It is designed for a light management. Remark that a new Item may not be Null, because this is the criterium used for "End of List"Auxiliary class for EntityList. An EntityList designates an EntityCluster, which brings itself an fixed maximum count of Entities. If it is full, it gives access to another cluster ("Next"). This class is intended to give a good compromise between access time (faster than a Sequence, good for little count) and memory use (better than a Sequence in any case, overall for little count, better than an Array for a very little count. It is designed for a light management. Remark that a new Item may not be Null, because this is the criterium used for "End of List"
"""
def Append(self,ent : OCP.Standard.Standard_Transient) -> None:
"""
Appends an Entity to the Cluster. If it is not full, adds the entity directly inside itself. Else, transmits to its Next and Creates it if it does not yet exist
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def FillIterator(self,iter : Interface_EntityIterator) -> None:
"""
Fills an Iterator with designated Entities (includes Next)
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def NbEntities(self) -> int:
"""
Returns total count of Entities (including Next)
"""
@overload
def Remove(self,num : int) -> bool:
"""
Removes an Entity from the Cluster. If it is not found, calls its Next one to do so. Returns True if it becomes itself empty, False else (thus, a Cluster which becomes empty is deleted from the list)
Removes an Entity from the Cluster, given its rank. If <num> is greater than NbLocal, calls its Next with (num - NbLocal), Returns True if it becomes itself empty, False else
"""
@overload
def Remove(self,ent : OCP.Standard.Standard_Transient) -> bool: ...
def SetValue(self,num : int,ent : OCP.Standard.Standard_Transient) -> None:
"""
Changes an Entity given its rank.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Value(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Returns the Entity identified by its rank in the list (including Next)
"""
@overload
def __init__(self,ent : OCP.Standard.Standard_Transient) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,ec : Interface_EntityCluster) -> None: ...
@overload
def __init__(self,ant : OCP.Standard.Standard_Transient,ec : Interface_EntityCluster) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_EntityIterator():
"""
Defines an Iterator on Entities. Allows considering of various criteria
"""
def AddItem(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
Adds to the iteration list a defined entity
"""
def AddList(self,list : OCP.TColStd.TColStd_HSequenceOfTransient) -> None:
"""
Gets a list of entities and adds its to the iteration list
"""
def Content(self) -> OCP.TColStd.TColStd_HSequenceOfTransient:
"""
Returns the content of the Iterator, accessed through a Handle to be used by a frontal-engine logic Returns an empty Sequence if the Iterator is empty Calls Start if not yet done
"""
def Destroy(self) -> None:
"""
Clears data of iteration
"""
def GetOneItem(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
same as AddItem (kept for compatibility)
"""
def More(self) -> bool:
"""
Says if there are other entities (vertices) to iterate the first time, calls Start
"""
def NbEntities(self) -> int:
"""
Returns count of entities which will be iterated on Calls Start if not yet done
"""
def NbTyped(self,type : OCP.Standard.Standard_Type) -> int:
"""
Returns count of entities of a given type (kind of)
"""
def Next(self) -> None:
"""
Sets iteration to the next entity (vertex) to give
"""
def SelectType(self,atype : OCP.Standard.Standard_Type,keep : bool) -> None:
"""
Selects entities with are Kind of a given type, keep only them (is keep is True) or reject only them (if keep is False)
"""
def Start(self) -> None:
"""
Allows re-iteration (useless for the first iteration)
"""
def Typed(self,type : OCP.Standard.Standard_Type) -> Interface_EntityIterator:
"""
Returns the list of entities of a given type (kind of)
"""
def Value(self) -> OCP.Standard.Standard_Transient:
"""
Returns the current Entity iterated, to be used by Interface tools
"""
@overload
def __init__(self,list : OCP.TColStd.TColStd_HSequenceOfTransient) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class Interface_EntityList():
"""
This class defines a list of Entities (Transient Objects), it can be used as a field of other Transient classes, with these features : - oriented to define a little list, that is, slower than an Array or a Map of Entities for a big count (about 100 and over), but faster than a Sequence - allows to work as a Sequence, limited to Clear, Append, Remove, Access to an Item identified by its rank in the list - space saving, compared to a Sequence, especially for little amounts; better than an Array for a very little amount (less than 10) but less good for a greater amount
"""
def Add(self,ent : OCP.Standard.Standard_Transient) -> None:
"""
Adds an Entity to the list, that is, with NO REGARD about the order (faster than Append if count becomes greater than 10)
"""
def Append(self,ent : OCP.Standard.Standard_Transient) -> None:
"""
Appends an Entity, that is to the END of the list (keeps order, but works slowerly than Add, see below)
"""
def Clear(self) -> None:
"""
Clears the List
"""
def FillIterator(self,iter : Interface_EntityIterator) -> None:
"""
fills an Iterator with the content of the list (normal way to consult a list which has been filled with Add)
"""
def IsEmpty(self) -> bool:
"""
Returns True if the list is empty
"""
def NbEntities(self) -> int:
"""
Returns count of recorded Entities
"""
def NbTypedEntities(self,atype : OCP.Standard.Standard_Type) -> int:
"""
Returns count of Entities of a given Type (0 : none)
"""
@overload
def Remove(self,num : int) -> None:
"""
Removes an Entity from the list, if it is there
Removes an Entity from the list, given its rank
"""
@overload
def Remove(self,ent : OCP.Standard.Standard_Transient) -> None: ...
def SetValue(self,num : int,ent : OCP.Standard.Standard_Transient) -> None:
"""
Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)
"""
def TypedEntity(self,atype : OCP.Standard.Standard_Type,num : int=0) -> OCP.Standard.Standard_Transient:
"""
Returns the Entity which is of a given type. If num = 0 (D), there must be ONE AND ONLY ONE If num > 0, returns the num-th entity of this type
"""
def Value(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append)
"""
def __init__(self) -> None: ...
pass
class Interface_FileParameter():
"""
Auxiliary class to store a literal parameter in a file intermediate directory or in an UndefinedContent : a reference type Parameter detains an Integer which is used to address a record in the directory. FileParameter is intended to be stored in a ParamSet : hence memory management is performed by ParamSet, which calls Clear to work, while the Destructor (see Destroy) does nothing. Also a FileParameter can be read for consultation only, not to be read from a Structure to be included into another one.
"""
def CValue(self) -> str:
"""
Same as above, but as a CString (for immediate exploitation) was C++ : return const
"""
def Clear(self) -> None:
"""
Clears stored data : frees memory taken for the String Value
"""
def Destroy(self) -> None:
"""
Destructor. Does nothing because Memory is managed by ParamSet
"""
def EntityNumber(self) -> int:
"""
Returns value set by SetEntityNumber
"""
@overload
def Init(self,val : OCP.TCollection.TCollection_AsciiString,typ : Interface_ParamType) -> None:
"""
Fills fields (with Entity Number set to zero)
Same as above, but builds the Value from a CString
"""
@overload
def Init(self,val : str,typ : Interface_ParamType) -> None: ...
def ParamType(self) -> Interface_ParamType:
"""
Returns the type of the parameter
"""
def SetEntityNumber(self,num : int) -> None:
"""
Allows to set a reference to an Entity in a numbered list
"""
def __init__(self) -> None: ...
pass
class Interface_FileReaderData(OCP.Standard.Standard_Transient):
"""
This class defines services which permit to access Data issued from a File, in a form which does not depend of physical format : thus, each Record has an attached ParamList (to be managed) and resulting Entity.This class defines services which permit to access Data issued from a File, in a form which does not depend of physical format : thus, each Record has an attached ParamList (to be managed) and resulting Entity.This class defines services which permit to access Data issued from a File, in a form which does not depend of physical format : thus, each Record has an attached ParamList (to be managed) and resulting Entity.
"""
@overload
def AddParam(self,num : int,FP : Interface_FileParameter) -> None:
"""
Adds a parameter to record no "num" and fills its fields (EntityNumber is optional) Warning : <aval> is assumed to be memory-managed elsewhere : it is NOT copied. This gives a best speed : strings remain stored in pages of characters
Same as above, but gets a AsciiString from TCollection Remark that the content of the AsciiString is locally copied (because its content is most often lost after using)
Same as above, but gets a complete FileParameter Warning : Content of <FP> is NOT copied : its original address and space in memory are assumed to be managed elsewhere (see ParamSet)
"""
@overload
def AddParam(self,num : int,aval : str,atype : Interface_ParamType,nument : int=0) -> None: ...
@overload
def AddParam(self,num : int,aval : OCP.TCollection.TCollection_AsciiString,atype : Interface_ParamType,nument : int=0) -> None: ...
def BindEntity(self,num : int,ent : OCP.Standard.Standard_Transient) -> None:
"""
Binds an entity to a record
"""
def BoundEntity(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Returns the entity bound to a record, set by SetEntities
"""
def ChangeParam(self,num : int,nump : int) -> Interface_FileParameter:
"""
Same as above, but in order to be modified on place
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def Destroy(self) -> None: ...
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def Fastof_s(str : str) -> float:
"""
Same spec.s as standard <atof> but 5 times faster
"""
def FindNextRecord(self,num : int) -> int:
"""
Determines the record number defining an Entity following a given record number. Specific to each sub-class of FileReaderData. Returning zero means no record found
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def InitParams(self,num : int) -> None:
"""
attaches an empty ParamList to a Record
"""
def IsErrorLoad(self) -> bool:
"""
Returns True if the status "Error Load" has been set (to True or False)
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsParamDefined(self,num : int,nump : int) -> bool:
"""
Returns True if parameter "nump" of record "num" is defined (it is not if its type is ParamVoid)
"""
def NbEntities(self) -> int:
"""
Returns the count of entities. Depending of each norm, records can be Entities or SubParts (SubList in STEP, SubGroup in SET ...). NbEntities counts only Entities, not Subs Used for memory reservation in InterfaceModel Default implementation uses FindNextRecord Can be redefined into a more performant way
"""
def NbParams(self,num : int) -> int:
"""
Returns count of parameters attached to record "num" If <num> = 0, returns the total recorded count of parameters
"""
def NbRecords(self) -> int:
"""
Returns the count of registered records That is, value given for Initialization (can be redefined)
"""
def Param(self,num : int,nump : int) -> Interface_FileParameter:
"""
Returns parameter "nump" of record "num", as a complete FileParameter
"""
def ParamCValue(self,num : int,nump : int) -> str:
"""
Same as above, but as a CString was C++ : return const
"""
def ParamEntity(self,num : int,nump : int) -> OCP.Standard.Standard_Transient:
"""
Returns the StepEntity referenced by a parameter Error if none
"""
def ParamFirstRank(self,num : int) -> int:
"""
Returns the absolute rank of the beginning of a record (its list is from ParamFirstRank+1 to ParamFirstRank+NbParams)
"""
def ParamNumber(self,num : int,nump : int) -> int:
"""
Returns record number of an entity referenced by a parameter of type Ident; 0 if no EntityNumber has been determined Note that it is used to reference Entities but also Sublists (sublists are not objects, but internal descriptions)
"""
def ParamType(self,num : int,nump : int) -> Interface_ParamType:
"""
Returns type of parameter "nump" of record "num" Returns literal value of parameter "nump" of record "num" was C++ : return const &
"""
def Params(self,num : int) -> Interface_ParamList:
"""
Returns the complete ParamList of a record (read only) num = 0 to return the whole param list for the file
"""
def ResetErrorLoad(self) -> bool:
"""
Returns the former value of status "Error Load" then resets it Used to read the status then ensure it is reset
"""
def SetErrorLoad(self,val : bool) -> None:
"""
Sets the status "Error Load" on, to overside check fails <val> True : declares unloaded <val> False : declares loaded If not called before loading (see FileReaderTool), check fails give the status IsErrorLoad says if SetErrorLoad has been called by user ResetErrorLoad resets it (called by FileReaderTool) This allows to specify that the currently loaded entity remains unloaded (because of syntactic fail)
"""
def SetParam(self,num : int,nump : int,FP : Interface_FileParameter) -> None:
"""
Sets a new value for a parameter of a record, given by : num : record number; nump : parameter number in the record
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_FileReaderTool():
"""
Defines services which are required to load an InterfaceModel from a File. Typically, it may firstly transform a system file into a FileReaderData object, then work on it, not longer considering file contents, to load an Interface Model. It may also work on a FileReaderData already loaded.
"""
def AnalyseRecord(self,num : int,anent : OCP.Standard.Standard_Transient,acheck : Interface_Check) -> bool:
"""
Fills an Entity, given record no; specific to each Interface, called by AnalyseFile from InterfaceModel (which manages its calling arguments) To work, each Interface can define a method in its proper Transient class, like this (given as an example) : AnalyseRecord (me : mutable; FR : in out FileReaderTool; num : Integer; acheck : in out Check) returns Boolean; and call it from AnalyseRecord
"""
def BeginRead(self,amodel : Interface_InterfaceModel) -> None:
"""
Fills model's header; each Interface defines for its Model its own file header; this method fills it from FileReaderTool.+ It is called by AnalyseFile from InterfaceModel
"""
def Clear(self) -> None:
"""
Clear fields
"""
def Data(self) -> Interface_FileReaderData:
"""
Returns the FileReaderData which is used to work
"""
def EndRead(self,amodel : Interface_InterfaceModel) -> None:
"""
Ends file reading after reading all the entities default is doing nothing; redefinable as necessary
"""
def ErrorHandle(self) -> bool:
"""
Returns ErrorHandle flag
"""
def LoadModel(self,amodel : Interface_InterfaceModel) -> None:
"""
Reads and fills Entities from the FileReaderData set by SetData to an InterfaceModel. It enchains required operations, the specific ones correspond to deferred methods (below) to be defined for each Norm. It manages also error recovery and trace. Remark : it calls SetModel. It Can raise any error which can occur during a load operation, unless Error Handling is set. This method can also be redefined if judged necessary.
"""
def LoadedEntity(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Reads, Fills and Returns one Entity read from a Record of the FileReaderData. This Method manages also case of Fail or Warning, by producing a ReportEntyty plus , for a Fail, a literal Content (as an UnknownEntity). Performs also Trace
"""
def Messenger(self) -> OCP.Message.Message_Messenger:
"""
Returns Messenger used for outputting messages. The returned object is guaranteed to be non-null; default is Message::Messenger().
"""
def Model(self) -> Interface_InterfaceModel:
"""
Returns the stored Model
"""
def NewModel(self) -> Interface_InterfaceModel:
"""
Creates an empty Model of the norm. Uses Protocol to do it
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the Protocol given at creation time
"""
def Recognize(self,num : int,ach : Interface_Check,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Recognizes a record, given its number. Specific to each Interface; called by SetEntities. It can call the basic method RecognizeByLib. Returns False if recognition has failed, True else. <ach> has not to be filled if simply Recognition has failed : it must record true error messages : RecognizeByLib can generate error messages if NewRead is called
"""
def RecognizeByLib(self,num : int,glib : Interface_GeneralLib,rlib : Interface_ReaderLib,ach : Interface_Check,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Recognizes a record with the help of Libraries. Can be used to implement the method Recognize. <rlib> is used to find Protocol and CaseNumber to apply <glib> performs the creation (by service NewVoid, or NewRead if NewVoid gave no result) <ach> is a check, which is transmitted to NewRead if it is called, gives a result but which is false <ent> is the result Returns False if recognition has failed, True else
"""
def SetData(self,reader : Interface_FileReaderData,protocol : Interface_Protocol) -> None:
"""
Sets Data to a FileReaderData. Works with a Protocol
"""
def SetEntities(self) -> None:
"""
Fills records with empty entities; once done, each entity can ask the FileReaderTool for any entity referenced through an identifier. Calls Recognize which is specific to each specific type of FileReaderTool
"""
def SetErrorHandle(self,err : bool) -> None:
"""
Allows controlling whether exception raisings are handled If err is False, they are not (hence, dbx can take control) If err is True, they are, and they are traced (by putting on messenger Entity's Number and file record num) Default given at Model's creation time is True
"""
def SetMessenger(self,messenger : OCP.Message.Message_Messenger) -> None:
"""
Sets Messenger used for outputting messages
"""
def SetModel(self,amodel : Interface_InterfaceModel) -> None:
"""
Stores a Model. Used when the Model has been loaded
"""
def SetTraceLevel(self,tracelev : int) -> None:
"""
Sets trace level used for outputting messages - 0: no trace at all - 1: errors - 2: errors and warnings - 3: all messages Default is 1 : Errors traced
"""
def TraceLevel(self) -> int:
"""
Returns trace level used for outputting messages.
"""
def UnknownEntity(self) -> OCP.Standard.Standard_Transient:
"""
Provides an unknown entity, specific to the Interface called by SetEntities when Recognize has failed (Unknown alone) or by LoadModel when an Entity has caused a Fail on reading (to keep at least its literal description) Uses Protocol to do it
"""
pass
class Interface_FloatWriter():
"""
This class converts a floating number (Real) to a string It can be used if the standard C-C++ output functions (sprintf or std::cout<<) are not convenient. That is to say : - to suppress trailing '0' and 'E+00' (if desired) - to control exponent output and floating point output
"""
@staticmethod
def Convert_s(val : float,text : str,zerosup : bool,Range1 : float,Range2 : float,mainform : str,rangeform : str) -> int:
"""
This class method converts a Real Value to a string, given options given as arguments. It can be called independently. Warning : even if declared in, content of <text> will be modified
"""
def FormatForRange(self) -> str:
"""
Returns the format for range, if set Meaningful only if <range> from Options is True was C++ : return const
"""
def MainFormat(self) -> str:
"""
Returns the main format was C++ : return const
"""
def Options(self) -> tuple[bool, bool, float, float]:
"""
Returns active options : <zerosup> is the option ZeroSuppress, <range> is True if a range is set, False else R1,R2 give the range (if it is set)
"""
def SetDefaults(self,chars : int=0) -> None:
"""
Sets again options to the defaults given by Create
"""
def SetFormat(self,form : str,reset : bool=True) -> None:
"""
Sets a specific Format for Sending Reals (main format) (Default from Creation is "%E") If <reset> is given True (default), this call clears effects of former calls to SetFormatForRange and SetZeroSuppress
"""
def SetFormatForRange(self,form : str,R1 : float,R2 : float) -> None:
"""
Sets a secondary Format for Real, to be applied between R1 and R2 (in absolute values). A Call to SetRealForm cancels this secondary form if <reset> is True. (Default from Creation is "%f" between 0.1 and 1000.) Warning : if the condition (0. <= R1 < R2) is not fulfilled, this secondary form is canceled.
"""
def SetZeroSuppress(self,mode : bool) -> None:
"""
Sets Sending Real Parameters to suppress trailing Zeros and Null Exponent ("E+00"), if <mode> is given True, Resets this mode if <mode> is False (in addition to Real Forms) A call to SetRealFrom resets this mode to False ig <reset> is given True (Default from Creation is True)
"""
def Write(self,val : float,text : str) -> int:
"""
Writes a Real value <val> to a string <text> by using the options. Returns the useful Length of produced string. It calls the class method Convert. Warning : <text> is assumed to be wide enough (20-30 is correct) And, even if declared in, its content will be modified
"""
def __init__(self,chars : int=0) -> None: ...
pass
class Interface_GTool(OCP.Standard.Standard_Transient):
"""
GTool - General Tool for a Model Provides the functions performed by Protocol/GeneralModule for entities of a Model, and recorded in a GeneralLib Optimized : once an entity has been queried, the GeneralLib is not longer queried Shareable between several users : as a HandleGTool - General Tool for a Model Provides the functions performed by Protocol/GeneralModule for entities of a Model, and recorded in a GeneralLib Optimized : once an entity has been queried, the GeneralLib is not longer queried Shareable between several users : as a HandleGTool - General Tool for a Model Provides the functions performed by Protocol/GeneralModule for entities of a Model, and recorded in a GeneralLib Optimized : once an entity has been queried, the GeneralLib is not longer queried Shareable between several users : as a Handle
"""
def ClearEntities(self) -> None:
"""
Clears the maps which record, for each already recorded entity its Module and Case Number
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Lib(self) -> Interface_GeneralLib:
"""
Returns the GeneralLib itself
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the Protocol. Warning : it can be Null
"""
def Reservate(self,nb : int,enforce : bool=False) -> None:
"""
Reservates maps for a count of entities <enforce> False : minimum count <enforce> True : clears former reservations Does not clear the maps
"""
def Select(self,ent : OCP.Standard.Standard_Transient,gmod : Interface_GeneralModule,CN : int,enforce : bool=False) -> bool:
"""
Selects for an entity, its Module and Case Number It is optimised : once done for each entity, the result is mapped and the GeneralLib is not longer queried <enforce> True overpasses this optimisation
"""
def SetProtocol(self,proto : Interface_Protocol,enforce : bool=False) -> None:
"""
Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done
"""
def SetSignType(self,sign : Interface_SignType) -> None:
"""
Sets a new SignType
"""
def SignName(self) -> str:
"""
Returns the Name of the SignType, or "Class Name"
"""
def SignType(self) -> Interface_SignType:
"""
Returns the SignType. Can be null
"""
def SignValue(self,ent : OCP.Standard.Standard_Transient,model : Interface_InterfaceModel) -> str:
"""
Returns the Signature for a Transient Object in a Model It calls SignType to do that If SignType is not defined, return ClassName of <ent>
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,proto : Interface_Protocol,nbent : int=0) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_GeneralLib():
"""
None
"""
def AddProtocol(self,aprotocol : OCP.Standard.Standard_Transient) -> None:
"""
Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)
"""
def Clear(self) -> None:
"""
Clears the list of Modules of a library (can be used to redefine the order of Modules before action : Clear then refill the Library by calls to AddProtocol)
"""
def Module(self) -> Interface_GeneralModule:
"""
Returns the current Module in the Iteration
"""
def More(self) -> bool:
"""
Returns True if there are more Modules to iterate on
"""
def Next(self) -> None:
"""
Iterates by getting the next Module in the list If there is none, the exception will be raised by Value
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the current Protocol in the Iteration
"""
def Select(self,obj : OCP.Standard.Standard_Transient,module : Interface_GeneralModule,CN : int) -> bool:
"""
Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)
"""
def SetComplete(self) -> None:
"""
Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)
"""
@staticmethod
def SetGlobal_s(amodule : Interface_GeneralModule,aprotocol : Interface_Protocol) -> None:
"""
Adds a couple (Module-Protocol) into the global definition set for this class of Library.
"""
def Start(self) -> None:
"""
Starts Iteration on the Modules (sets it on the first one)
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,aprotocol : Interface_Protocol) -> None: ...
pass
class Interface_GeneralModule(OCP.Standard.Standard_Transient):
"""
This class defines general services, which must be provided for each type of Entity (i.e. of Transient Object processed by an Interface) : Shared List, Check, Copy, Delete, CategoryThis class defines general services, which must be provided for each type of Entity (i.e. of Transient Object processed by an Interface) : Shared List, Check, Copy, Delete, CategoryThis class defines general services, which must be provided for each type of Entity (i.e. of Transient Object processed by an Interface) : Shared List, Check, Copy, Delete, Category
"""
def CanCopy(self,CN : int,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Specific answer to the question "is Copy properly implemented" Remark that it should be in phase with the implementation of NewVoid+CopyCase/NewCopyCase Default returns always False, can be redefined
"""
def CategoryNumber(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : Interface_ShareTool) -> int:
"""
Returns a category number which characterizes an entity Category Numbers are managed by the class Category <shares> can be used to evaluate this number in the context Default returns 0 which means "unspecified"
"""
def CheckCase(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : Interface_ShareTool,ach : Interface_Check) -> Any:
"""
Specific Checking of an Entity <ent> Can check context queried through a ShareTool, as required
"""
def CopyCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : Interface_CopyTool) -> None:
"""
Specific Copy ("Deep") from <entfrom> to <entto> (same type) by using a CopyTool which provides its working Map. Use method Transferred from CopyTool to work
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def Dispatch(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : Interface_CopyTool) -> bool:
"""
Dispatches an entity Returns True if it works by copy, False if it just duplicates the starting Handle
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def FillShared(self,model : Interface_InterfaceModel,CN : int,ent : OCP.Standard.Standard_Transient,iter : Interface_EntityIterator) -> None:
"""
Specific filling of the list of Entities shared by an Entity <ent>, according a Case Number <CN> (formerly computed by CaseNum), considered in the context of a Model <model> Default calls FillSharedCase (i.e., ignores the model) Can be redefined to use the model for working
"""
def FillSharedCase(self,CN : int,ent : OCP.Standard.Standard_Transient,iter : Interface_EntityIterator) -> None:
"""
Specific filling of the list of Entities shared by an Entity <ent>, according a Case Number <CN> (formerly computed by CaseNum). Can use the internal utility method Share, below
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def ListImplied(self,model : Interface_InterfaceModel,CN : int,ent : OCP.Standard.Standard_Transient,iter : Interface_EntityIterator) -> None:
"""
List the Implied References of <ent> considered in the context of a Model <model> : i.e. the Entities which are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillShared + ListImplied give the complete list of References Default calls ListImpliedCase (i.e. ignores the model) Can be redefined to use the model for working
"""
def ListImpliedCase(self,CN : int,ent : OCP.Standard.Standard_Transient,iter : Interface_EntityIterator) -> None:
"""
List the Implied References of <ent> (see above) are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillSharedCase + ListImpliedCase give the complete list of Referenced Entities The provided default method does nothing (Implied References are specific of a little amount of Entity Classes).
"""
def Name(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : Interface_ShareTool) -> OCP.TCollection.TCollection_HAsciiString:
"""
Determines if an entity brings a Name (or widerly, if a Name can be attached to it, through the ShareTool By default, returns a Null Handle (no name can be produced) Can be redefined
"""
def NewCopiedCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : Interface_CopyTool) -> bool:
"""
Specific operator (create+copy) defaulted to do nothing. It can be redefined : When it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructor : hence the result <entto> must be created with an effective definition. Remark : if NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else
"""
def NewVoid(self,CN : int,entto : OCP.Standard.Standard_Transient) -> bool:
"""
Creates a new void entity <entto> according to a Case Number This entity remains to be filled, by reading from a file or by copying from another entity of same type (see CopyCase)
"""
def RenewImpliedCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : Interface_CopyTool) -> None:
"""
Specific Copying of Implied References A Default is provided which does nothing (must current case !) Already copied references (by CopyFrom) must remain unchanged Use method Search from CopyTool to work
"""
def Share(self,iter : Interface_EntityIterator,shared : OCP.Standard.Standard_Transient) -> None:
"""
Adds an Entity to a Shared List (uses GetOneItem on <iter>)
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def WhenDeleteCase(self,CN : int,ent : OCP.Standard.Standard_Transient,dispatched : bool) -> None:
"""
Prepares an entity to be deleted. What does it mean : Basically, any class of entity may define its own destructor By default, it does nothing but calling destructors on fields With the Memory Manager, it is useless to call destructor, it is done automatically when the Handle is nullified(cleared) BUT this is ineffective in looping structures (whatever these are "Implied" references or not).
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_GlobalNodeOfGeneralLib(OCP.Standard.Standard_Transient):
def Add(self,amodule : Interface_GeneralModule,aprotocol : Interface_Protocol) -> None:
"""
Adds a Module bound with a Protocol to the list : does nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondence
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Module(self) -> Interface_GeneralModule:
"""
Returns the Module stored in a given GlobalNode
"""
def Next(self) -> Interface_GlobalNodeOfGeneralLib:
"""
Returns the Next GlobalNode. If none is defined, returned value is a Null Handle
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the attached Protocol stored in a given GlobalNode
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_GlobalNodeOfReaderLib(OCP.Standard.Standard_Transient):
def Add(self,amodule : Interface_ReaderModule,aprotocol : Interface_Protocol) -> None:
"""
Adds a Module bound with a Protocol to the list : does nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondence
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Module(self) -> Interface_ReaderModule:
"""
Returns the Module stored in a given GlobalNode
"""
def Next(self) -> Interface_GlobalNodeOfReaderLib:
"""
Returns the Next GlobalNode. If none is defined, returned value is a Null Handle
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the attached Protocol stored in a given GlobalNode
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_Graph():
"""
Gives basic data structure for operating and storing graph results (usage is normally internal) Entities are Mapped according their Number in the Model
"""
def BitMap(self) -> Interface_BitMap:
"""
Returns the Bit Map in order to read or edit flag values
"""
def CBitMap(self) -> Interface_BitMap:
"""
Returns the Bit Map in order to edit it (add new flags)
"""
def ChangeStatus(self,oldstat : int,newstat : int) -> None:
"""
Changes all status which value is oldstat to new value newstat
"""
def Entity(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Returns mapped Entity given its no (if it is present)
"""
def EntityNumber(self,ent : OCP.Standard.Standard_Transient) -> int:
"""
Returns the Number of the entity in the Map, computed at creation time (Entities loaded from the Model) Returns 0 if <ent> not contained by Model used to create <me> (that is, <ent> is unknown from <me>)
"""
@overload
def GetFromEntity(self,ent : OCP.Standard.Standard_Transient,shared : bool,newstat : int,overlapstat : int,cumul : bool) -> None:
"""
Gets an Entity, plus its shared ones (at every level) if "shared" is True. New items are set to status "newstat" Items already present in graph remain unchanged Of course, redefinitions of Shared lists are taken into account if there are some
Gets an Entity, plus its shared ones (at every level) if "shared" is True. New items are set to status "newstat". Items already present in graph are processed as follows : - if they already have status "newstat", they remain unchanged - if they have another status, this one is modified : if cumul is True, to former status + overlapstat (cumul) if cumul is False, to overlapstat (enforce)
"""
@overload
def GetFromEntity(self,ent : OCP.Standard.Standard_Transient,shared : bool,newstat : int=0) -> None: ...
@overload
def GetFromGraph(self,agraph : Interface_Graph) -> None:
"""
Gets all present items from another graph
Gets items from another graph which have a specific Status
"""
@overload
def GetFromGraph(self,agraph : Interface_Graph,stat : int) -> None: ...
@overload
def GetFromIter(self,iter : Interface_EntityIterator,newstat : int,overlapstat : int,cumul : bool) -> None:
"""
Gets Entities given by an EntityIterator. Entities which were not yet present in the graph are mapped with status "newstat" Entities already present remain unchanged
Gets Entities given by an EntityIterator and distinguishes those already present in the Graph : - new entities added to the Graph with status "newstst" - entities already present with status = "newstat" remain unchanged - entities already present with status different form "newstat" have their status modified : if cumul is True, to former status + overlapstat (cumul) if cumul is False, to overlapstat (enforce) (Note : works as GetEntity, shared = False, for each entity)
"""
@overload
def GetFromIter(self,iter : Interface_EntityIterator,newstat : int) -> None: ...
def GetFromModel(self) -> None:
"""
Loads Graph with all Entities contained in the Model
"""
def GetShareds(self,ent : OCP.Standard.Standard_Transient) -> OCP.TColStd.TColStd_HSequenceOfTransient:
"""
Returns the sequence of Entities Shared by an Entity
"""
def GetSharings(self,ent : OCP.Standard.Standard_Transient) -> OCP.TColStd.TColStd_HSequenceOfTransient:
"""
Returns the sequence of Entities Sharings by an Entity
"""
def HasShareErrors(self,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if <ent> or the list of entities shared by <ent> (not redefined) contains items unknown from this Graph Remark : apart from the status HasShareError, these items are ignored
"""
@overload
def IsPresent(self,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if an Entity is noted as present in the graph (See methods Get... which determine this status) Returns False if <num> is out of range too
Same as above but directly on an Entity <ent> : if it is not contained in the Model, returns False. Else calls IsPresent(num) with <num> given by EntityNumber
"""
@overload
def IsPresent(self,num : int) -> bool: ...
def ModeStat(self) -> bool:
"""
Returns mode responsible for computation of statuses;
"""
def Model(self) -> Interface_InterfaceModel:
"""
Returns the Model with which this Graph was created
"""
def Name(self,ent : OCP.Standard.Standard_Transient) -> OCP.TCollection.TCollection_HAsciiString:
"""
Determines the name attached to an entity, by using the general service Name in GeneralModule Returns a null handle if no name could be computed or if the entity is not in the model
"""
def NbStatuses(self) -> int:
"""
Returns size of array of statuses
"""
def RemoveItem(self,num : int) -> None:
"""
Clears Entity and sets Status to 0, for a numero
"""
def RemoveStatus(self,stat : int) -> None:
"""
Removes all items of which status has a given value stat
"""
def Reset(self) -> None:
"""
Erases data, making graph ready to rebegin from void (also resets Shared lists redefinitions)
"""
def ResetStatus(self) -> None:
"""
Erases Status (Values and Flags of Presence), making graph ready to rebegin from void. Does not concerns Shared lists
"""
def RootEntities(self) -> Interface_EntityIterator:
"""
Returns the Entities which are not Shared (their Sharing List is empty) in the Model
"""
def SetStatus(self,num : int,stat : int) -> None:
"""
Modifies Status associated to a numero
"""
def Shareds(self,ent : OCP.Standard.Standard_Transient) -> Interface_EntityIterator:
"""
Returns the list of Entities Shared by an Entity, as recorded by the Graph. That is, by default Basic Shared List, else it can be redefined by methods SetShare, SetNoShare ... see below
"""
def SharingTable(self) -> OCP.TColStd.TColStd_HArray1OfListOfInteger:
"""
Returns the Table of Sharing lists. Used to Create another Graph from <me>
"""
def Sharings(self,ent : OCP.Standard.Standard_Transient) -> Interface_EntityIterator:
"""
Returns the list of Entities which Share an Entity, computed from the Basic or Redefined Shared Lists
"""
def Size(self) -> int:
"""
Returns size (max nb of entities, i.e. Model's nb of entities)
"""
def Status(self,num : int) -> int:
"""
Returns Status associated to a numero (only to read it)
"""
def TypedSharings(self,ent : OCP.Standard.Standard_Transient,type : OCP.Standard.Standard_Type) -> Interface_EntityIterator:
"""
Returns the list of sharings entities, AT ANY LEVEL, which are kind of a given type. A sharing entity kind of this type ends the exploration of its branch
"""
@overload
def __init__(self,agraph : Interface_Graph,copied : bool=False) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,lib : Interface_GeneralLib,theModeStats : bool=True) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,protocol : Interface_Protocol,theModeStats : bool=True) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,theModeStats : bool=True) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,gtool : Interface_GTool,theModeStats : bool=True) -> None: ...
pass
class Interface_GraphContent(Interface_EntityIterator):
"""
Defines general form for classes of graph algorithms on Interfaces, this form is that of EntityIterator Each sub-class fills it according to its own algorithm This also allows to combine any graph result to others, all being given under one unique form
"""
def AddItem(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
Adds to the iteration list a defined entity
"""
def AddList(self,list : OCP.TColStd.TColStd_HSequenceOfTransient) -> None:
"""
Gets a list of entities and adds its to the iteration list
"""
def Begin(self) -> None:
"""
Does the Evaluation before starting the iteration itself (in out)
"""
def Content(self) -> OCP.TColStd.TColStd_HSequenceOfTransient:
"""
Returns the content of the Iterator, accessed through a Handle to be used by a frontal-engine logic Returns an empty Sequence if the Iterator is empty Calls Start if not yet done
"""
def Destroy(self) -> None:
"""
Clears data of iteration
"""
def Evaluate(self) -> None:
"""
Evaluates list of Entities to be iterated. Called by Start Default is set to doing nothing : intended to be redefined by each sub-class
"""
@overload
def GetFromGraph(self,agraph : Interface_Graph) -> None:
"""
Gets all Entities designated by a Graph (once created), adds them to those already recorded
Gets entities from a graph which have a specific Status value (one created), adds them to those already recorded
"""
@overload
def GetFromGraph(self,agraph : Interface_Graph,stat : int) -> None: ...
def GetOneItem(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
same as AddItem (kept for compatibility)
"""
def More(self) -> bool:
"""
Says if there are other entities (vertices) to iterate the first time, calls Start
"""
def NbEntities(self) -> int:
"""
Returns count of entities which will be iterated on Calls Start if not yet done
"""
def NbTyped(self,type : OCP.Standard.Standard_Type) -> int:
"""
Returns count of entities of a given type (kind of)
"""
def Next(self) -> None:
"""
Sets iteration to the next entity (vertex) to give
"""
def Result(self) -> Interface_EntityIterator:
"""
Returns Result under the exact form of an EntityIterator : Can be used when EntityIterator itself is required (as a returned value for instance), without way for a sub-class
"""
def SelectType(self,atype : OCP.Standard.Standard_Type,keep : bool) -> None:
"""
Selects entities with are Kind of a given type, keep only them (is keep is True) or reject only them (if keep is False)
"""
def Start(self) -> None:
"""
Allows re-iteration (useless for the first iteration)
"""
def Typed(self,type : OCP.Standard.Standard_Type) -> Interface_EntityIterator:
"""
Returns the list of entities of a given type (kind of)
"""
def Value(self) -> OCP.Standard.Standard_Transient:
"""
Returns the current Entity iterated, to be used by Interface tools
"""
@overload
def __init__(self,agraph : Interface_Graph,ent : OCP.Standard.Standard_Transient) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,agraph : Interface_Graph) -> None: ...
@overload
def __init__(self,agraph : Interface_Graph,stat : int) -> None: ...
pass
class Interface_HArray1OfHAsciiString(Interface_Array1OfHAsciiString, OCP.Standard.Standard_Transient):
def Array1(self) -> Interface_Array1OfHAsciiString:
"""
None
"""
def Assign(self,theOther : Interface_Array1OfHAsciiString) -> Interface_Array1OfHAsciiString:
"""
Copies data of theOther array to this. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.
"""
def ChangeArray1(self) -> Interface_Array1OfHAsciiString:
"""
None
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def Init(self,theValue : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Initialise the items with theValue
"""
def IsDeletable(self) -> bool:
"""
None
"""
def IsEmpty(self) -> bool:
"""
Return TRUE if array has zero length.
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Length(self) -> int:
"""
Length query (the same)
"""
def Lower(self) -> int:
"""
Lower bound
"""
def Move(self,theOther : Interface_Array1OfHAsciiString) -> Interface_Array1OfHAsciiString:
"""
None
"""
def Resize(self,theLower : int,theUpper : int,theToCopyData : bool) -> None:
"""
Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.
"""
def SetValue(self,theIndex : int,theItem : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Set value
"""
def Size(self) -> int:
"""
Size query
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def UpdateLowerBound(self,theLower : int) -> None:
"""
Changes the lowest bound. Do not move data
"""
def UpdateUpperBound(self,theUpper : int) -> None:
"""
Changes the upper bound. Do not move data
"""
def Upper(self) -> int:
"""
Upper bound
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> OCP.TCollection.TCollection_HAsciiString: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theOther : Interface_Array1OfHAsciiString) -> None: ...
@overload
def __init__(self,theBegin : OCP.TCollection.TCollection_HAsciiString,theLower : int,theUpper : int,arg4 : bool) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int,theValue : OCP.TCollection.TCollection_HAsciiString) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int) -> None: ...
def __iter__(self) -> Iterator[OCP.TCollection.TCollection_HAsciiString]: ...
def __len__(self) -> int: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_HGraph(OCP.Standard.Standard_Transient):
"""
This class allows to store a redefinable Graph, via a Handle (useful for an Object which can work on several successive Models, with the same general conditions)This class allows to store a redefinable Graph, via a Handle (useful for an Object which can work on several successive Models, with the same general conditions)This class allows to store a redefinable Graph, via a Handle (useful for an Object which can work on several successive Models, with the same general conditions)
"""
def CGraph(self) -> Interface_Graph:
"""
Same as above, but for Read-Write Operations Then, The Graph will be modified in the HGraph itself
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def Graph(self) -> Interface_Graph:
"""
Returns the Graph contained in <me>, for Read Only Operations Remark that it is returns as "const &" Getting it in a new variable instead of a reference would be a pity, because all the graph's content would be duplicated
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@overload
def __init__(self,amodel : Interface_InterfaceModel,gtool : Interface_GTool,theModeStats : bool=True) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,protocol : Interface_Protocol,theModeStats : bool=True) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,theModeStats : bool=True) -> None: ...
@overload
def __init__(self,agraph : Interface_Graph) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,lib : Interface_GeneralLib,theModeStats : bool=True) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_SequenceOfCheck(OCP.NCollection.NCollection_BaseSequence):
"""
Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
@overload
def Append(self,theItem : Interface_Check) -> None:
"""
Append one item
Append another sequence (making it empty)
"""
@overload
def Append(self,theSeq : Interface_SequenceOfCheck) -> None: ...
def Assign(self,theOther : Interface_SequenceOfCheck) -> Interface_SequenceOfCheck:
"""
Replace this sequence by the items of theOther. This method does not change the internal allocator.
"""
def ChangeFirst(self) -> Interface_Check:
"""
First item access
"""
def ChangeLast(self) -> Interface_Check:
"""
Last item access
"""
def ChangeValue(self,theIndex : int) -> Interface_Check:
"""
Variable item access by theIndex
"""
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None:
"""
Clear the items out, take a new allocator if non null
"""
def Exchange(self,I : int,J : int) -> None:
"""
Exchange two members
"""
def First(self) -> Interface_Check:
"""
First item access
"""
@overload
def InsertAfter(self,theIndex : int,theItem : Interface_Check) -> None:
"""
InsertAfter theIndex another sequence (making it empty)
InsertAfter theIndex theItem
"""
@overload
def InsertAfter(self,theIndex : int,theSeq : Interface_SequenceOfCheck) -> None: ...
@overload
def InsertBefore(self,theIndex : int,theItem : Interface_Check) -> None:
"""
InsertBefore theIndex theItem
InsertBefore theIndex another sequence (making it empty)
"""
@overload
def InsertBefore(self,theIndex : int,theSeq : Interface_SequenceOfCheck) -> None: ...
def IsEmpty(self) -> bool:
"""
Empty query
"""
def Last(self) -> Interface_Check:
"""
Last item access
"""
def Length(self) -> int:
"""
Number of items
"""
def Lower(self) -> int:
"""
Method for consistency with other collections.
"""
@overload
def Prepend(self,theSeq : Interface_SequenceOfCheck) -> None:
"""
Prepend one item
Prepend another sequence (making it empty)
"""
@overload
def Prepend(self,theItem : Interface_Check) -> None: ...
@overload
def Remove(self,theIndex : int) -> None:
"""
Remove one item
Remove range of items
"""
@overload
def Remove(self,theFromIndex : int,theToIndex : int) -> None: ...
def Reverse(self) -> None:
"""
Reverse sequence
"""
def SetValue(self,theIndex : int,theItem : Interface_Check) -> None:
"""
Set item value by theIndex
"""
def Size(self) -> int:
"""
Number of items
"""
def Split(self,theIndex : int,theSeq : Interface_SequenceOfCheck) -> None:
"""
Split in two sequences
"""
def Upper(self) -> int:
"""
Method for consistency with other collections.
"""
def Value(self,theIndex : int) -> Interface_Check:
"""
Constant item access by theIndex
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> Interface_Check:
"""
Constant operator()
Variable operator()
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theOther : Interface_SequenceOfCheck) -> None: ...
@overload
def __init__(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator) -> None: ...
def __iter__(self) -> Iterator[Interface_Check]: ...
def __len__(self) -> int: ...
@staticmethod
def delNode_s(theNode : NCollection_SeqNode,theAl : OCP.NCollection.NCollection_BaseAllocator) -> None:
"""
Static deleter to be passed to BaseSequence
"""
pass
class Interface_IndexedMapOfAsciiString(OCP.NCollection.NCollection_BaseMap):
"""
Purpose: An indexed map is used to store keys and to bind an index to them. Each new key stored in the map gets an index. Index are incremented as keys are stored in the map. A key can be found by the index and an index by the key. No key but the last can be removed so the indices are in the range 1..Extent. See the class Map from NCollection for a discussion about the number of buckets.
"""
def Add(self,theKey1 : OCP.TCollection.TCollection_AsciiString) -> int:
"""
Add
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
def Assign(self,theOther : Interface_IndexedMapOfAsciiString) -> Interface_IndexedMapOfAsciiString:
"""
Assign. This method does not change the internal allocator.
"""
@overload
def Clear(self,doReleaseMemory : bool=False) -> None:
"""
Clear data. If doReleaseMemory is false then the table of buckets is not released and will be reused.
Clear data and reset allocator
"""
@overload
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator) -> None: ...
def Contains(self,theKey1 : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Contains
"""
def Exchange(self,theOther : Interface_IndexedMapOfAsciiString) -> None:
"""
Exchange the content of two maps without re-allocations. Notice that allocators will be swapped as well!
"""
def Extent(self) -> int:
"""
Extent
"""
def FindIndex(self,theKey1 : OCP.TCollection.TCollection_AsciiString) -> int:
"""
FindIndex
"""
def FindKey(self,theIndex : int) -> OCP.TCollection.TCollection_AsciiString:
"""
FindKey
"""
def IsEmpty(self) -> bool:
"""
IsEmpty
"""
def NbBuckets(self) -> int:
"""
NbBuckets
"""
def ReSize(self,theExtent : int) -> None:
"""
ReSize
"""
def RemoveFromIndex(self,theIndex : int) -> None:
"""
Remove the key of the given index. Caution! The index of the last key can be changed.
"""
def RemoveKey(self,theKey1 : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Remove the given key. Caution! The index of the last key can be changed.
"""
def RemoveLast(self) -> None:
"""
RemoveLast
"""
def Size(self) -> int:
"""
Size
"""
def Statistics(self,S : io.BytesIO) -> None:
"""
Statistics
"""
def Substitute(self,theIndex : int,theKey1 : OCP.TCollection.TCollection_AsciiString) -> None:
"""
Substitute
"""
def Swap(self,theIndex1 : int,theIndex2 : int) -> None:
"""
Swaps two elements with the given indices.
"""
def __call__(self,theIndex : int) -> OCP.TCollection.TCollection_AsciiString: ...
@overload
def __init__(self,theNbBuckets : int,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None: ...
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theOther : Interface_IndexedMapOfAsciiString) -> None: ...
def __iter__(self) -> Iterator[OCP.TCollection.TCollection_AsciiString]: ...
def __len__(self) -> int: ...
pass
class Interface_IntList():
"""
This class detains the data which describe a Graph. A Graph has two lists, one for shared refs, one for sharing refs (the reverses). Each list comprises, for each Entity of the Model of the Graph, a list of Entities (shared or sharing). In fact, entities are identified by their numbers in the Model or Graph : this gives better performances.
"""
def Add(self,ref : int) -> None:
"""
Adds a reference (as an integer value, an entity number) to the current entity number. Zero is ignored
"""
def AdjustSize(self,margin : int=0) -> None:
"""
Resizes lists to exact sizes. For list of refs, a positive margin can be added.
"""
def Clear(self) -> None:
"""
Clears all data, hence each entity number has an empty list
"""
def Initialize(self,nbe : int) -> None:
"""
Initialize IntList by number of entities.
"""
def Internals(self,ents : OCP.TColStd.TColStd_HArray1OfInteger,refs : OCP.TColStd.TColStd_HArray1OfInteger) -> tuple[int]:
"""
Returns internal values, used for copying
"""
def IsRedefined(self,num : int=0) -> bool:
"""
Returns True if the list for a number (default is taken as current) is "redefined" (useful for empty list)
"""
def Length(self) -> int:
"""
Returns the count of refs attached to current entity number
"""
def List(self,number : int,copied : bool=False) -> Interface_IntList:
"""
Returns an IntList, identical to <me> but set to a specified entity Number By default, not copied (in order to be read) Specified <copied> to produce another list and edit it
"""
def NbEntities(self) -> int:
"""
Returns count of entities to be aknowledged
"""
def Number(self) -> int:
"""
Returns the current entity number
"""
def Remove(self,num : int) -> bool:
"""
Removes an item in the list for current number, given its rank Returns True if done, False else
"""
def Reservate(self,count : int) -> None:
"""
Makes a reservation for <count> references to be later attached to the current entity. If required, it increases the size of array used to store refs. Remark that if count is less than two, it does nothing (because immediate storing)
"""
def SetNbEntities(self,nbe : int) -> None:
"""
Changes the count of entities (ignored if decreased)
"""
def SetNumber(self,number : int) -> None:
"""
Sets an entity number as current (for read and fill)
"""
def SetRedefined(self,mode : bool) -> None:
"""
Sets current entity list to be redefined or not This is used in a Graph for redefinition list : it can be disable (no redefinition, i.e. list is cleared), or enabled (starts as empty). The original list has not to be "redefined"
"""
def Value(self,num : int) -> int:
"""
Returns a reference number in the list for current number, according to its rank
"""
@overload
def __init__(self,other : Interface_IntList,copied : bool) -> None: ...
@overload
def __init__(self,nbe : int) -> None: ...
@overload
def __init__(self) -> None: ...
pass
class Interface_IntVal(OCP.Standard.Standard_Transient):
"""
An Integer through a Handle (i.e. managed as TShared)An Integer through a Handle (i.e. managed as TShared)An Integer through a Handle (i.e. managed as TShared)
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Value(self) -> int:
"""
None
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
@property
def CValue(self) -> int:
"""
None
:type: int
"""
@CValue.setter
def CValue(self, arg1: int) -> None:
"""
None
"""
pass
class Interface_InterfaceError(Exception, BaseException):
class type():
pass
__cause__: getset_descriptor # value = <attribute '__cause__' of 'BaseException' objects>
__context__: getset_descriptor # value = <attribute '__context__' of 'BaseException' objects>
__dict__: mappingproxy # value = mappingproxy({'__module__': 'OCP.Interface', '__weakref__': <attribute '__weakref__' of 'Interface_InterfaceError' objects>, '__doc__': None})
__suppress_context__: member_descriptor # value = <member '__suppress_context__' of 'BaseException' objects>
__traceback__: getset_descriptor # value = <attribute '__traceback__' of 'BaseException' objects>
__weakref__: getset_descriptor # value = <attribute '__weakref__' of 'Interface_InterfaceError' objects>
args: getset_descriptor # value = <attribute 'args' of 'BaseException' objects>
pass
class Interface_InterfaceMismatch(Exception, BaseException):
class type():
pass
__cause__: getset_descriptor # value = <attribute '__cause__' of 'BaseException' objects>
__context__: getset_descriptor # value = <attribute '__context__' of 'BaseException' objects>
__dict__: mappingproxy # value = mappingproxy({'__module__': 'OCP.Interface', '__weakref__': <attribute '__weakref__' of 'Interface_InterfaceMismatch' objects>, '__doc__': None})
__suppress_context__: member_descriptor # value = <member '__suppress_context__' of 'BaseException' objects>
__traceback__: getset_descriptor # value = <attribute '__traceback__' of 'BaseException' objects>
__weakref__: getset_descriptor # value = <attribute '__weakref__' of 'Interface_InterfaceMismatch' objects>
args: getset_descriptor # value = <attribute 'args' of 'BaseException' objects>
pass
class Interface_InterfaceModel(OCP.Standard.Standard_Transient):
"""
Defines an (Indexed) Set of data corresponding to a complete Transfer by a File Interface, i.e. File Header and Transient Entities (Objects) contained in a File. Contained Entities are identified in the Model by unique and consecutive Numbers.Defines an (Indexed) Set of data corresponding to a complete Transfer by a File Interface, i.e. File Header and Transient Entities (Objects) contained in a File. Contained Entities are identified in the Model by unique and consecutive Numbers.Defines an (Indexed) Set of data corresponding to a complete Transfer by a File Interface, i.e. File Header and Transient Entities (Objects) contained in a File. Contained Entities are identified in the Model by unique and consecutive Numbers.
"""
def AddEntity(self,anentity : OCP.Standard.Standard_Transient) -> None:
"""
Internal method for adding an Entity. Used by file reading (defined by each Interface) and Transfer tools. It adds the entity required to be added, not its refs : see AddWithRefs. If <anentity> is a ReportEntity, it is added to the list of Reports, its Concerned Entity (Erroneous or Corrected, else Unknown) is added to the list of Entities. That is, the ReportEntity must be created before Adding
"""
def AddReportEntity(self,rep : Interface_ReportEntity,semantic : bool=False) -> bool:
"""
Adds a ReportEntity as such. Returns False if the concerned entity is not recorded in the Model Else, adds it into, either the main report list or the list for semantic checks, then returns True
"""
@overload
def AddWithRefs(self,anent : OCP.Standard.Standard_Transient,level : int=0,listall : bool=False) -> None:
"""
Adds to the Model, an Entity with all its References, as they are defined by General Services FillShared and ListImplied. Process is recursive (any sub-levels) if <level> = 0 (Default) Else, adds sub-entities until the required sub-level. Especially, if <level> = 1, adds immediate subs and that's all
Same as above, but works with the Protocol of the Model
Same as above, but works with an already created GeneralLib
"""
@overload
def AddWithRefs(self,anent : OCP.Standard.Standard_Transient,lib : Interface_GeneralLib,level : int=0,listall : bool=False) -> None: ...
@overload
def AddWithRefs(self,anent : OCP.Standard.Standard_Transient,proto : Interface_Protocol,level : int=0,listall : bool=False) -> None: ...
def CategoryNumber(self,num : int) -> int:
"""
Returns the recorded category number for a given entity number 0 if none was defined for this entity
"""
def ChangeOrder(self,oldnum : int,newnum : int,count : int=1) -> None:
"""
Changes the Numbers of some Entities : <oldnum> is moved to <newnum>, same for <count> entities. Thus : 1,2 ... newnum-1 newnum ... oldnum .. oldnum+count oldnum+count+1 .. gives 1,2 ... newnum-1 oldnum .. oldnum+count newnum ... oldnum+count+1 (can be seen as a circular permutation)
"""
def Check(self,num : int,syntactic : bool) -> Interface_Check:
"""
Returns the check attached to an entity, designated by its Number. 0 for global check <semantic> True : recorded semantic check <semantic> False : recorded syntactic check (see ReportEntity) If no check is recorded for <num>, returns an empty Check
"""
@staticmethod
def ClassName_s(typnam : str) -> str:
"""
From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed
"""
def Clear(self) -> None:
"""
Erases contained data; used when a Model is copied to others : the new copied ones begin from clear Clear calls specific method ClearHeader (see below)
"""
def ClearEntities(self) -> None:
"""
Clears the entities; uses the general service WhenDelete, in addition to the standard Memory Manager; can be redefined
"""
def ClearHeader(self) -> None:
"""
Clears Model's header : specific to each norm
"""
def ClearLabels(self) -> None:
"""
Erases information about labels, if any : specific to each norm
"""
def ClearReportEntity(self,num : int) -> bool:
"""
Removes the ReportEntity attached to Entity <num>. Returns True if done, False if no ReportEntity was attached to <num>. Warning : the caller must assume that this clearing is meaningful
"""
def Contains(self,anentity : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if a Model contains an Entity (for a ReportEntity, looks for the ReportEntity itself AND its Concerned Entity)
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def Destroy(self) -> None:
"""
Clears the list of entities (service WhenDelete)
"""
def DumpHeader(self,S : io.BytesIO,level : int=0) -> None:
"""
Dumps Header in a short, easy to read, form, onto a Stream <level> allows to print more or less parts of the header, if necessary. 0 for basic print
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Entities(self) -> Interface_EntityIterator:
"""
Returns the list of all Entities, as an Iterator on Entities (the Entities themselves, not the Reports)
"""
def EntityState(self,num : int) -> Interface_DataState:
"""
Returns the State of an entity, given its number
"""
def FillIterator(self,iter : Interface_EntityIterator) -> None:
"""
Allows an EntityIterator to get a list of Entities
"""
def FillSemanticChecks(self,checks : Interface_CheckIterator,clear : bool=True) -> None:
"""
Fills the list of semantic checks. This list is computed (by CheckTool). Hence, it can be stored in the model for later queries <clear> True (D) : new list replaces <clear> False : new list is cumulated
"""
def GTool(self) -> Interface_GTool:
"""
Returns the GTool, set by SetProtocol or by SetGTool
"""
def GetFromAnother(self,other : Interface_InterfaceModel) -> None:
"""
Gets header (data specific of a defined Interface) from another InterfaceModel; called from TransferCopy
"""
def GetFromTransfer(self,aniter : Interface_EntityIterator) -> None:
"""
Gets contents from an EntityIterator, prepared by a Transfer tool (e.g TransferCopy). Starts from clear
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def GlobalCheck(self,syntactic : bool=True) -> Interface_Check:
"""
Returns the GlobalCheck, which memorizes messages global to the file (not specific to an Entity), especially Header
"""
def HasSemanticChecks(self) -> bool:
"""
Returns True if semantic checks have been filled
"""
@staticmethod
def HasTemplate_s(name : str) -> bool:
"""
Returns true if a template is attached to a given name
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsErrorEntity(self,num : int) -> bool:
"""
Returns True if <num> identifies an Error Entity : in this case, a ReportEntity brings Fail Messages and possibly an "undefined" Content, see IsRedefinedEntity
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsRedefinedContent(self,num : int) -> bool:
"""
Returns True if <num> identifies an Entity which content is redefined through a ReportEntity (i.e. with literal data only) This happens when an entity is syntactically erroneous in the way that its basic content remains empty. For more details (such as content itself), see ReportEntity
"""
def IsReportEntity(self,num : int,semantic : bool=False) -> bool:
"""
Returns True if <num> identifies a ReportEntity in the Model Hence, ReportEntity can be called.
"""
def IsUnknownEntity(self,num : int) -> bool:
"""
Returns True if <num> identifies an Unknown Entity : in this case, a ReportEntity with no Check Messages designates it.
"""
@staticmethod
def ListTemplates_s() -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns the complete list of names attached to template models
"""
def NbEntities(self) -> int:
"""
Returns count of contained Entities
"""
def NbTypes(self,ent : OCP.Standard.Standard_Transient) -> int:
"""
Returns the count of DISTINCT types under which an entity may be processed. Defined by the Protocol, which gives default as 1 (dynamic Type).
"""
def NewEmptyModel(self) -> Interface_InterfaceModel:
"""
Returns a New Empty Model, same type as <me> (whatever its Type); called to Copy parts a Model into other ones, then followed by a call to GetFromAnother (Header) then filling with specified Entities, themselves copied
"""
def NextNumberForLabel(self,label : str,lastnum : int=0,exact : bool=True) -> int:
"""
Searches a label which matches with one entity. Begins from <lastnum>+1 (default:1) and scans the entities until <NbEntities>. For the first which matches <label>, this method returns its Number. Returns 0 if nothing found Can be called recursively (labels are not specified as unique) <exact> : if True (default), exact match is required else, checks the END of entity label
"""
def Number(self,anentity : OCP.Standard.Standard_Transient) -> int:
"""
Returns the Number of an Entity in the Model if it contains it. Else returns 0. For a ReportEntity, looks at Concerned Entity. Returns the Directory entry Number of an Entity in the Model if it contains it. Else returns 0. For a ReportEntity, looks at Concerned Entity.
"""
def Print(self,ent : OCP.Standard.Standard_Transient,s : io.BytesIO,mode : int=0) -> None:
"""
Prints identification of a given entity in <me>, in order to be printed in a list or phrase <mode> < 0 : prints only its number <mode> = 1 : just calls PrintLabel <mode> = 0 (D) : prints its number plus '/' plus PrintLabel If <ent> == <me>, simply prints "Global" If <ent> is unknown, prints "??/its type"
"""
def PrintLabel(self,ent : OCP.Standard.Standard_Transient,S : io.BytesIO) -> None:
"""
Prints label specific to each norm, for a given entity. Must only print label itself, in order to be included in a phrase. Can call the result of StringLabel, but not obliged.
"""
def PrintToLog(self,ent : OCP.Standard.Standard_Transient,S : io.BytesIO) -> None:
"""
Prints label specific to each norm in log format, for a given entity. By default, just calls PrintLabel, can be redefined
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the Protocol which has been set by SetProtocol, or AddWithRefs with Protocol
"""
def Redefineds(self) -> Interface_EntityIterator:
"""
Returns the list of ReportEntities which redefine data (generally, if concerned entity is "Error", a literal content is added to it : this is a "redefined entity"
"""
def ReplaceEntity(self,nument : int,anent : OCP.Standard.Standard_Transient) -> None:
"""
Replace Entity with Number=nument on other entity - "anent"
"""
def ReportEntity(self,num : int,semantic : bool=False) -> Interface_ReportEntity:
"""
Returns a ReportEntity identified by its number in the Model, or a Null Handle If <num> does not identify a ReportEntity.
"""
def Reports(self,semantic : bool=False) -> Interface_EntityIterator:
"""
Returns the list of all ReportEntities, i.e. data about Entities read with Error or Warning information (each item has to be casted to Report Entity then it can be queried for Concerned Entity, Content, Check ...) By default, returns the main reports, is <semantic> is True it returns the list for semantic checks
"""
def Reservate(self,nbent : int) -> None:
"""
Does a reservation for the List of Entities (for optimized storage management). If it is not called, storage management can be less efficient. <nbent> is the expected count of Entities to store
"""
def ReverseOrders(self,after : int=0) -> None:
"""
Reverses the Numbers of the Entities, between <after> and the total count of Entities. Thus, the entities : 1,2 ... after, after+1 ... nb-1, nb become numbered as : 1,2 ... after, nb, nb-1 ... after+1 By default (after = 0) the whole list of Entities is reversed
"""
def SetCategoryNumber(self,num : int,val : int) -> bool:
"""
Records a category number for an entity number Returns True when done, False if <num> is out of range
"""
def SetGTool(self,gtool : Interface_GTool) -> None:
"""
Sets a GTool for this model, which already defines a Protocol
"""
def SetGlobalCheck(self,ach : Interface_Check) -> None:
"""
Allows to modify GlobalCheck, after getting then completing it Remark : it is SYNTACTIC check. Semantics, see FillChecks
"""
def SetProtocol(self,proto : Interface_Protocol) -> None:
"""
Sets a Protocol for this Model It is also set by a call to AddWithRefs with Protocol It is used for : DumpHeader (as required), ClearEntities ...
"""
def SetReportEntity(self,num : int,rep : Interface_ReportEntity) -> bool:
"""
Sets or Replaces a ReportEntity for the Entity <num>. Returns True if Report is replaced, False if it has been replaced Warning : the caller must assume that this setting is meaningful
"""
@staticmethod
def SetTemplate_s(name : str,model : Interface_InterfaceModel) -> bool:
"""
Records a new template model with a name. If the name was already recorded, the corresponding template is replaced by the new one. Then, WARNING : test HasTemplate to avoid surprises
"""
def StringLabel(self,ent : OCP.Standard.Standard_Transient) -> OCP.TCollection.TCollection_HAsciiString:
"""
Returns a string with the label attached to a given entity. Warning : While this string may be edited on the spot, if it is a read field, the returned value must be copied before.
"""
@staticmethod
def Template_s(name : str) -> Interface_InterfaceModel:
"""
Returns the template model attached to a name, or a Null Handle
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Type(self,ent : OCP.Standard.Standard_Transient,num : int=1) -> OCP.Standard.Standard_Type:
"""
Returns a type, given its rank : defined by the Protocol (by default, the first one)
"""
def TypeName(self,ent : OCP.Standard.Standard_Transient,complete : bool=True) -> str:
"""
Returns the type name of an entity, from the list of types (one or more ...) <complete> True (D) gives the complete type, else packages are removed WARNING : buffered, to be immediately copied or printed
"""
def Value(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Returns an Entity identified by its number in the Model Each sub-class of InterfaceModel can define its own method Entity to return its specific class of Entity (e.g. for VDA, VDAModel returns a VDAEntity), working by calling Value Remark : For a Reported Entity, (Erroneous, Corrected, Unknown), this method returns this Reported Entity. See ReportEntity for other questions.
"""
def VerifyCheck(self,ach : Interface_Check) -> Any:
"""
Minimum Semantic Global Check on data in model (header) Can only check basic Data. See also GlobalCheck from Protocol for a check which takes the Graph into account Default does nothing, can be redefined
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
@property
def DispatchStatus(self) -> bool:
"""
Returns the Dispatch Status, either for get or set A Model which is produced from Dispatch may share entities with the original (according to the Protocol), hence these non-copied entities should not be deleted
:type: bool
"""
@DispatchStatus.setter
def DispatchStatus(self, arg1: bool) -> None:
"""
Returns the Dispatch Status, either for get or set A Model which is produced from Dispatch may share entities with the original (according to the Protocol), hence these non-copied entities should not be deleted
"""
pass
class Interface_LineBuffer():
"""
Simple Management of a Line Buffer, to be used by Interface File Writers. While a String is suitable to do that, this class ensures an optimised Memory Management, because this is a hard point of File Writing.
"""
@overload
def Add(self,text : str) -> None:
"""
Adds a text as a CString. Its Length is evaluated from the text (by C function strlen)
Adds a text as a CString. Its length is given as <lntext>
Adds a text as a AsciiString from TCollection
Adds a text made of only ONE Character
"""
@overload
def Add(self,text : OCP.TCollection.TCollection_AsciiString) -> None: ...
@overload
def Add(self,text : str,lntext : int) -> None: ...
def CanGet(self,more : int) -> bool:
"""
Returns True if there is room enough to add <more> characters Else, it is required to Dump the Buffer before refilling it <more> is recorded to manage SetKeep status
"""
def Clear(self) -> None:
"""
Clears completely the LineBuffer
"""
def Content(self) -> str:
"""
Returns the Content of the LineBuffer
"""
def FreezeInitial(self) -> None:
"""
Inhibits effect of SetInitial until the next Move (i.e. Keep) Then Prepare will not insert initial blanks, but further ones will. This allows to cancel initial blanks on an internal Split A call to SetInitial has no effect on this until Move
"""
def Length(self) -> int:
"""
Returns the Length of the LineBuffer
"""
@overload
def Move(self,str : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Fills a AsciiString <str> with the Content of the Line Buffer, then Clears the LineBuffer
Same as above, but <str> is known through a Handle
"""
@overload
def Move(self,str : OCP.TCollection.TCollection_AsciiString) -> None: ...
def Moved(self) -> OCP.TCollection.TCollection_HAsciiString:
"""
Same as above, but generates the HAsciiString
"""
def SetInitial(self,initial : int) -> None:
"""
Sets an Initial reservation for Blank characters (this reservation is counted in the size of the current Line)
"""
def SetKeep(self) -> None:
"""
Sets a Keep Status at current Length. It means that at next Move, the new line will begin by characters between Keep + 1 and current Length
"""
def SetMax(self,max : int) -> None:
"""
Changes Maximum allowed size of Buffer. If <max> is Zero, Maximum size is set to the initial size.
"""
def __init__(self,size : int=10) -> None: ...
pass
class Interface_MSG():
"""
This class gives a set of functions to manage and use a list of translated messages (messagery)
"""
@staticmethod
@overload
def Blanks_s(val : int,max : int) -> str:
"""
Returns a blank string, of length between 0 and <max>, to fill the printing of a numeric value <val>, i.e. : If val < 10 , max-1 blanks If val between 10 and 99, max-2 blanks ... etc...
Returns a blank string, to complete a given string <val> up to <max> characters : If strlen(val) is 0, max blanks If strlen(val) is 5, max-5 blanks etc...
Returns a blank string of <count> blanks (mini 0, maxi 76)
"""
@staticmethod
@overload
def Blanks_s(val : str,max : int) -> str: ...
@staticmethod
@overload
def Blanks_s(count : int) -> str: ...
@staticmethod
def CDate_s(text1 : str,text2 : str) -> int:
"""
Returns a value about comparison of two dates 0 : equal. <0 text1 anterior. >0 text1 posterior
"""
def Destroy(self) -> None:
"""
Optimised destructor (applies for additional forms of Create)
"""
@staticmethod
def Intervalled_s(val : float,order : int=3,upper : bool=False) -> float:
"""
Returns an "intervalled" value from a starting real <val> : i.e. a value which is rounded on an interval limit Interval limits are defined to be in a coarsely "geometric" progression (two successive intervals are inside a limit ratio)
"""
@staticmethod
def IsKey_s(mess : str) -> bool:
"""
Returns True if a given message is surely a key (according to the form adopted for keys) (before activating messages, answer is false)
"""
@staticmethod
def NDate_s(text : str,yy : int,mm : int,dd : int,hh : int,mn : int,ss : int) -> bool:
"""
Decodes a date to numeric integer values Returns True if OK, False if text does not fit with required format. Incomplete forms are allowed (for instance, for only YYYY-MM-DD, hour is zero)
"""
@staticmethod
def PrintTrace_s(S : io.BytesIO) -> None:
"""
Prints the recorded errors (without title; can be empty, this is the normally expected case)
"""
@staticmethod
def Print_s(S : io.BytesIO,val : str,max : int,just : int=-1) -> None:
"""
Prints a String on an Output Stream, as follows : Accompanied with blanks, to give up to <max> charis at all, justified according just : -1 (D) : left 0 : center 1 : right Maximum 76 characters
"""
@staticmethod
@overload
def Read_s(S : io.BytesIO) -> int:
"""
Reads a list of messages from a stream, returns read count 0 means empty file, -1 means error
Reads a list of messages from a file defined by its name
"""
@staticmethod
@overload
def Read_s(file : str) -> int: ...
@staticmethod
def Record_s(key : str,item : str) -> None:
"""
Fills the dictionary with a couple (key-item) If a key is already recorded, it is possible to : - keep the last definition, and activate the trace system
"""
@staticmethod
def SetMode_s(running : bool,raising : bool) -> None:
"""
Sets the main modes for MSG : - if <running> is True, translation works normally - if <running> is False, translated item equate keys - if <raising> is True, errors (from Record or Translate) cause MSG to raise an exception - if <raising> is False, MSG runs without exception, then see also Trace Modes above
"""
@staticmethod
def SetTrace_s(toprint : bool,torecord : bool) -> None:
"""
Sets the trace system to work when activated, as follow : - if <toprint> is True, print immediately on standard output - if <torecord> is True, record it for further print
"""
@staticmethod
def TDate_s(text : str,yy : int,mm : int,dd : int,hh : int,mn : int,ss : int,format : str='') -> None:
"""
Codes a date as a text, from its numeric value (-> seconds) : YYYY-MM-DD:HH-MN-SS fixed format, completed by leading zeros Another format can be provided, as follows : C:%d ... C like format, preceded by C: S:... format to call system (not yet implemented)
"""
@staticmethod
def Translated_s(key : str) -> str:
"""
Returns the item recorded for a key. Returns the key itself if : - it is not recorded (then, the trace system is activated) - MSG has been required to be hung on
"""
def Value(self) -> str:
"""
Returns the translated message, in a functional form with operator () was C++ : return const
"""
@staticmethod
def Write_s(S : io.BytesIO,rootkey : str='') -> int:
"""
Writes the list of messages recorded to be translated, to a stream. Writes all the list (Default) or only keys which begin by <rootkey>. Returns the count of written messages
"""
@overload
def __init__(self,key : str,ival : int,str : str) -> None: ...
@overload
def __init__(self,key : str,i1 : int,i2 : int) -> None: ...
@overload
def __init__(self,key : str,str : str) -> None: ...
@overload
def __init__(self,key : str,i1 : int) -> None: ...
@overload
def __init__(self,key : str) -> None: ...
@overload
def __init__(self,key : str,r1 : float,intervals : int=-1) -> None: ...
pass
class Interface_NodeOfGeneralLib(OCP.Standard.Standard_Transient):
def AddNode(self,anode : Interface_GlobalNodeOfGeneralLib) -> None:
"""
Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Module(self) -> Interface_GeneralModule:
"""
Returns the Module designated by a precise Node
"""
def Next(self) -> Interface_NodeOfGeneralLib:
"""
Returns the Next Node. If none was defined, returned value is a Null Handle
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the Protocol designated by a precise Node
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_NodeOfReaderLib(OCP.Standard.Standard_Transient):
def AddNode(self,anode : Interface_GlobalNodeOfReaderLib) -> None:
"""
Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Module(self) -> Interface_ReaderModule:
"""
Returns the Module designated by a precise Node
"""
def Next(self) -> Interface_NodeOfReaderLib:
"""
Returns the Next Node. If none was defined, returned value is a Null Handle
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the Protocol designated by a precise Node
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_ParamList(OCP.Standard.Standard_Transient):
def ChangeValue(self,Index : int) -> Interface_FileParameter:
"""
return the value of the <Index>th element of the array.
"""
def Clear(self) -> None:
"""
None
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Length(self) -> int:
"""
Returns the number of elements of <me>.
Returns the number of elements of <me>.
"""
def Lower(self) -> int:
"""
Returns the lower bound. Warning
Returns the lower bound. Warning
"""
def SetValue(self,Index : int,Value : Interface_FileParameter) -> None:
"""
Assigns the value <Value> to the <Index>-th item of this array.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Upper(self) -> int:
"""
Returns the upper bound. Warning
Returns the upper bound. Warning
"""
def Value(self,Index : int) -> Interface_FileParameter:
"""
Return the value of the <Index>th element of the array.
"""
def __call__(self,Index : int) -> Interface_FileParameter:
"""
None
None
"""
def __init__(self,theIncrement : int=256) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_ParamSet(OCP.Standard.Standard_Transient):
"""
Defines an ordered set of FileParameters, in a way to be efficient as in memory requirement or in speedDefines an ordered set of FileParameters, in a way to be efficient as in memory requirement or in speedDefines an ordered set of FileParameters, in a way to be efficient as in memory requirement or in speed
"""
@overload
def Append(self,val : str,lnval : int,typ : Interface_ParamType,nument : int) -> int:
"""
Adds a parameter defined as its Value (CString and length) and Type. Optional EntityNumber (for FileReaderData) can be given Allows a better memory management than Appending a complete FileParameter If <lnval> < 0, <val> is assumed to be managed elsewhere : its address is stored as such. Else, <val> is copied in a locally (quickly) managed Page of Characters Returns new count of recorded Parameters
Adds a parameter at the end of the ParamSet (transparent about reservation and "Next") Returns new count of recorded Parameters
"""
@overload
def Append(self,FP : Interface_FileParameter) -> int: ...
def ChangeParam(self,num : int) -> Interface_FileParameter:
"""
Same as above, but in order to be modified on place
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def Destroy(self) -> None: ...
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def NbParams(self) -> int:
"""
Returns the total count of parameters (including nexts)
"""
def Param(self,num : int) -> Interface_FileParameter:
"""
Returns a parameter identified by its number
"""
def Params(self,num : int,nb : int) -> Interface_ParamList:
"""
Builds and returns the sub-list corresponding to parameters, from "num" included, with count "nb" If <num> and <nb> are zero, returns the whole list
"""
def SetParam(self,num : int,FP : Interface_FileParameter) -> None:
"""
Changes a parameter identified by its number
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self,nres : int,nst : int=1) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_ParamType():
"""
None
Members:
Interface_ParamMisc
Interface_ParamInteger
Interface_ParamReal
Interface_ParamIdent
Interface_ParamVoid
Interface_ParamText
Interface_ParamEnum
Interface_ParamLogical
Interface_ParamSub
Interface_ParamHexa
Interface_ParamBinary
"""
def __eq__(self,other : object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self,value : int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self,other : object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self,state : int) -> None: ...
def __str__(self) -> str: ...
@property
def name(self) -> None:
"""
:type: None
"""
@property
def value(self) -> int:
"""
:type: int
"""
Interface_ParamBinary: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamBinary: 10>
Interface_ParamEnum: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamEnum: 6>
Interface_ParamHexa: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamHexa: 9>
Interface_ParamIdent: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamIdent: 3>
Interface_ParamInteger: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamInteger: 1>
Interface_ParamLogical: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamLogical: 7>
Interface_ParamMisc: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamMisc: 0>
Interface_ParamReal: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamReal: 2>
Interface_ParamSub: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamSub: 8>
Interface_ParamText: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamText: 5>
Interface_ParamVoid: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamVoid: 4>
__entries: dict # value = {'Interface_ParamMisc': (<Interface_ParamType.Interface_ParamMisc: 0>, None), 'Interface_ParamInteger': (<Interface_ParamType.Interface_ParamInteger: 1>, None), 'Interface_ParamReal': (<Interface_ParamType.Interface_ParamReal: 2>, None), 'Interface_ParamIdent': (<Interface_ParamType.Interface_ParamIdent: 3>, None), 'Interface_ParamVoid': (<Interface_ParamType.Interface_ParamVoid: 4>, None), 'Interface_ParamText': (<Interface_ParamType.Interface_ParamText: 5>, None), 'Interface_ParamEnum': (<Interface_ParamType.Interface_ParamEnum: 6>, None), 'Interface_ParamLogical': (<Interface_ParamType.Interface_ParamLogical: 7>, None), 'Interface_ParamSub': (<Interface_ParamType.Interface_ParamSub: 8>, None), 'Interface_ParamHexa': (<Interface_ParamType.Interface_ParamHexa: 9>, None), 'Interface_ParamBinary': (<Interface_ParamType.Interface_ParamBinary: 10>, None)}
__members__: dict # value = {'Interface_ParamMisc': <Interface_ParamType.Interface_ParamMisc: 0>, 'Interface_ParamInteger': <Interface_ParamType.Interface_ParamInteger: 1>, 'Interface_ParamReal': <Interface_ParamType.Interface_ParamReal: 2>, 'Interface_ParamIdent': <Interface_ParamType.Interface_ParamIdent: 3>, 'Interface_ParamVoid': <Interface_ParamType.Interface_ParamVoid: 4>, 'Interface_ParamText': <Interface_ParamType.Interface_ParamText: 5>, 'Interface_ParamEnum': <Interface_ParamType.Interface_ParamEnum: 6>, 'Interface_ParamLogical': <Interface_ParamType.Interface_ParamLogical: 7>, 'Interface_ParamSub': <Interface_ParamType.Interface_ParamSub: 8>, 'Interface_ParamHexa': <Interface_ParamType.Interface_ParamHexa: 9>, 'Interface_ParamBinary': <Interface_ParamType.Interface_ParamBinary: 10>}
pass
class Interface_Protocol(OCP.Standard.Standard_Transient):
"""
General description of Interface Protocols. A Protocol defines a set of Entity types. This class provides also the notion of Active Protocol, as a working context, defined once then exploited by various Tools and Libraries.General description of Interface Protocols. A Protocol defines a set of Entity types. This class provides also the notion of Active Protocol, as a working context, defined once then exploited by various Tools and Libraries.General description of Interface Protocols. A Protocol defines a set of Entity types. This class provides also the notion of Active Protocol, as a working context, defined once then exploited by various Tools and Libraries.
"""
@staticmethod
def Active_s() -> Interface_Protocol:
"""
Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol")
"""
def CaseNumber(self,obj : OCP.Standard.Standard_Transient) -> int:
"""
Returns a unique positive CaseNumber for each Recognized Object. By default, recognition is based on Type(1) By default, calls the following one which is deferred.
"""
@staticmethod
def ClearActive_s() -> None:
"""
Erases the Active Protocol (hence it becomes undefined)
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def GlobalCheck(self,G : Interface_Graph,ach : Interface_Check) -> bool:
"""
Evaluates a Global Check for a model (with its Graph) Returns True when done, False if data in model do not apply
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsDynamicType(self,obj : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if type of <obj> is that defined from CDL This is the default but it may change according implementation
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsSuitableModel(self,model : Interface_InterfaceModel) -> bool:
"""
Returns True if <model> is a Model of the considered Norm
"""
def IsUnknownEntity(self,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if <ent> is an Unknown Entity for the Norm, i.e. same Type as them created by method UnknownEntity (for an Entity out of the Norm, answer can be unpredicable)
"""
def NbResources(self) -> int:
"""
Returns count of Protocol used as Resources (level one)
"""
def NbTypes(self,obj : OCP.Standard.Standard_Transient) -> int:
"""
Returns the count of DISTINCT types under which an entity may be processed. Each one is candidate to be recognized by TypeNumber, <obj> is then processed according it By default, returns 1 (the DynamicType)
"""
def NewModel(self) -> Interface_InterfaceModel:
"""
Creates an empty Model of the considered Norm
"""
def Resource(self,num : int) -> Interface_Protocol:
"""
Returns a Resource, given its rank (between 1 and NbResources)
"""
@staticmethod
def SetActive_s(aprotocol : Interface_Protocol) -> None:
"""
Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Type(self,obj : OCP.Standard.Standard_Transient,nt : int=1) -> OCP.Standard.Standard_Type:
"""
Returns a type under which <obj> can be recognized and processed, according its rank in its definition list (see NbTypes). By default, returns DynamicType
"""
def TypeNumber(self,atype : OCP.Standard.Standard_Type) -> int:
"""
Returns a unique positive CaseNumber for each Recognized Type, Returns Zero for "<type> not recognized"
"""
def UnknownEntity(self) -> OCP.Standard.Standard_Transient:
"""
Creates a new Unknown Entity for the considered Norm
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_ReaderLib():
"""
None
"""
def AddProtocol(self,aprotocol : OCP.Standard.Standard_Transient) -> None:
"""
Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)
"""
def Clear(self) -> None:
"""
Clears the list of Modules of a library (can be used to redefine the order of Modules before action : Clear then refill the Library by calls to AddProtocol)
"""
def Module(self) -> Interface_ReaderModule:
"""
Returns the current Module in the Iteration
"""
def More(self) -> bool:
"""
Returns True if there are more Modules to iterate on
"""
def Next(self) -> None:
"""
Iterates by getting the next Module in the list If there is none, the exception will be raised by Value
"""
def Protocol(self) -> Interface_Protocol:
"""
Returns the current Protocol in the Iteration
"""
def Select(self,obj : OCP.Standard.Standard_Transient,module : Interface_ReaderModule,CN : int) -> bool:
"""
Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)
"""
def SetComplete(self) -> None:
"""
Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)
"""
@staticmethod
def SetGlobal_s(amodule : Interface_ReaderModule,aprotocol : Interface_Protocol) -> None:
"""
Adds a couple (Module-Protocol) into the global definition set for this class of Library.
"""
def Start(self) -> None:
"""
Starts Iteration on the Modules (sets it on the first one)
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,aprotocol : Interface_Protocol) -> None: ...
pass
class Interface_ReaderModule(OCP.Standard.Standard_Transient):
"""
Defines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the EntityDefines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the EntityDefines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the Entity
"""
def CaseNum(self,data : Interface_FileReaderData,num : int) -> int:
"""
Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def NewRead(self,casenum : int,data : Interface_FileReaderData,num : int,ach : Interface_Check,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Specific operator (create+read) defaulted to do nothing. It can be redefined when it is not possible to work in two steps (NewVoid then Read). This occurs when no default constructor is defined : hence the result <ent> must be created with an effective definition from the reader. Remark : if NewRead is defined, Copy has nothing to do.
"""
def Read(self,casenum : int,data : Interface_FileReaderData,num : int,ach : Interface_Check,ent : OCP.Standard.Standard_Transient) -> Any:
"""
Performs the effective loading from <data>, record <num>, to the Entity <ent> formerly created In case of Error or Warning, fills <ach> with messages Remark that the Case Number comes from translating a record
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_ReportEntity(OCP.Standard.Standard_Transient):
"""
A ReportEntity is produced to aknowledge and memorize the binding between a Check and an Entity. The Check can bring Fails (+ Warnings if any), or only Warnings. If it is empty, the Report Entity is for an Unknown Entity.A ReportEntity is produced to aknowledge and memorize the binding between a Check and an Entity. The Check can bring Fails (+ Warnings if any), or only Warnings. If it is empty, the Report Entity is for an Unknown Entity.A ReportEntity is produced to aknowledge and memorize the binding between a Check and an Entity. The Check can bring Fails (+ Warnings if any), or only Warnings. If it is empty, the Report Entity is for an Unknown Entity.
"""
def CCheck(self) -> Interface_Check:
"""
Returns the stored Check in order to change it
"""
def Check(self) -> Interface_Check:
"""
Returns the stored Check
"""
def Concerned(self) -> OCP.Standard.Standard_Transient:
"""
Returns the stored Concerned Entity. It equates the Content in the case of an Unknown Entity
"""
def Content(self) -> OCP.Standard.Standard_Transient:
"""
Returns the stored Content, or a Null Handle Remark that it must be an "Unknown Entity" suitable for the norm of the containing Model
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def HasContent(self) -> bool:
"""
Returns True if a Content is stored (it can equate Concerned)
"""
def HasNewContent(self) -> bool:
"""
Returns True if a Content is stored AND differs from Concerned (i.e. redefines content) : used when Concerned could not be loaded
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsError(self) -> bool:
"""
Returns True for an Error Entity, i.e. if the Check brings at least one Fail message
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsUnknown(self) -> bool:
"""
Returns True for an Unknown Entity, i,e. if the Check is empty and Concerned equates Content
"""
def SetContent(self,content : OCP.Standard.Standard_Transient) -> None:
"""
Sets a Content : it brings non interpreted data which belong to the Concerned Entity. It can be empty then loaded later. Remark that for an Unknown Entity, Content is set by Create.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@overload
def __init__(self,acheck : Interface_Check,concerned : OCP.Standard.Standard_Transient) -> None: ...
@overload
def __init__(self,unknown : OCP.Standard.Standard_Transient) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_STAT():
"""
This class manages statistics to be queried asynchronously. Way of use : An operator describes a STAT form then fills it according to its progression. This produces a state of advancement of the process. This state can then be queried asynchronously : typically it is summarised as a percentage. There are also an identification of the current state, and information on processed volume.
"""
def AddPhase(self,weight : float,name : str='') -> None:
"""
Adds a new phase to the description. The first one after Create replaces the default unique one
"""
def AddStep(self,weight : float=1.0) -> None:
"""
Adds a new step for the last added phase, the default unique one if no AddPhase has already been added Warning : AddStep before the first AddPhase are cancelled
"""
@staticmethod
def End_s() -> None:
"""
Commands to declare the process ended (hence, advancement is forced to 100 %)
"""
def Internals(self,tit : OCP.TCollection.TCollection_HAsciiString,phn : OCP.TColStd.TColStd_HSequenceOfAsciiString,phw : OCP.TColStd.TColStd_HSequenceOfReal,phdeb : OCP.TColStd.TColStd_HSequenceOfInteger,phfin : OCP.TColStd.TColStd_HSequenceOfInteger,stw : OCP.TColStd.TColStd_HSequenceOfReal) -> tuple[float]:
"""
Returns fields in once, without copying them, used for copy when starting
"""
@staticmethod
def NextCycle_s(items : int) -> None:
"""
Commands to resume the preceding cycle and start a new one, with a count of items Ignored if count of cycles is already passed Then, first step is started (or default one) NextItem can be called for the first step, or NextStep to pass to the next one
"""
@staticmethod
def NextItem_s(nbitems : int=1) -> None:
"""
Commands to add an item in the current step of the current cycle of the current phase By default, one item per call, can be overpassed Ignored if count of items of this cycle is already passed
"""
@staticmethod
def NextPhase_s(items : int,cycles : int=1) -> None:
"""
Commands to resume the preceding phase and start a new one <items> and <cycles> as for Start, but for this new phase Ignored if count of phases is already passed If <cycles> is more than one, the first Cycle must then be started by NextCycle (NextStep/NextItem are ignored). If it is one, NextItem/NextStep can then be called
"""
@staticmethod
def NextStep_s() -> None:
"""
Commands to resume the preceding step of the cycle Ignored if count of steps is already passed NextItem can be called for this step, NextStep passes to next
"""
@staticmethod
def Percent_s(phase : bool=False) -> int:
"""
Returns the advancement as a percentage : <phase> True : inside the current phase <phase> False (D) : relative to the whole process
"""
@staticmethod
def SetPhase_s(items : int,cycles : int=1) -> None:
"""
Changes the parameters of the phase to start To be used before first counting (i.e. just after NextPhase) Can be used by an operator which has to reajust counts on run
"""
def Start(self,items : int,cycles : int=1) -> None:
"""
Starts a STAT on its first phase (or its default one) <items> gives the total count of items, <cycles> the count of cycles If <cycles> is more than one, the first Cycle must then be started by NextCycle (NextStep/NextItem are ignored). If it is one, NextItem/NextStep can then be called
"""
@staticmethod
def StartCount_s(items : int,title : str='') -> None:
"""
Starts a default STAT, with no phase, no step, ready to just count items. <items> gives the total count of items Hence, NextItem is available to directly count
"""
def Step(self,num : int) -> float:
"""
Returns weight of a Step, related to the cumul given for the phase. <num> is given by <n0step> + i, i between 1 and <nbsteps> (default gives n0step < 0 then weight is one)
"""
@staticmethod
def Where_s(phase : bool=True) -> str:
"""
Returns an identification of the STAT : <phase> True (D) : the name of the current phase <phase> False : the title of the current STAT
"""
@overload
def __init__(self,other : Interface_STAT) -> None: ...
@overload
def __init__(self,title : str='') -> None: ...
pass
class Interface_HSequenceOfCheck(Interface_SequenceOfCheck, OCP.NCollection.NCollection_BaseSequence, OCP.Standard.Standard_Transient):
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
@overload
def Append(self,theItem : Interface_Check) -> None:
"""
None
None
"""
@overload
def Append(self,theSequence : Interface_SequenceOfCheck) -> None: ...
def Assign(self,theOther : Interface_SequenceOfCheck) -> Interface_SequenceOfCheck:
"""
Replace this sequence by the items of theOther. This method does not change the internal allocator.
"""
def ChangeFirst(self) -> Interface_Check:
"""
First item access
"""
def ChangeLast(self) -> Interface_Check:
"""
Last item access
"""
def ChangeSequence(self) -> Interface_SequenceOfCheck:
"""
None
"""
def ChangeValue(self,theIndex : int) -> Interface_Check:
"""
Variable item access by theIndex
"""
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None:
"""
Clear the items out, take a new allocator if non null
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Exchange(self,I : int,J : int) -> None:
"""
Exchange two members
"""
def First(self) -> Interface_Check:
"""
First item access
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def InsertAfter(self,theIndex : int,theItem : Interface_Check) -> None:
"""
InsertAfter theIndex another sequence (making it empty)
InsertAfter theIndex theItem
"""
@overload
def InsertAfter(self,theIndex : int,theSeq : Interface_SequenceOfCheck) -> None: ...
@overload
def InsertBefore(self,theIndex : int,theItem : Interface_Check) -> None:
"""
InsertBefore theIndex theItem
InsertBefore theIndex another sequence (making it empty)
"""
@overload
def InsertBefore(self,theIndex : int,theSeq : Interface_SequenceOfCheck) -> None: ...
def IsEmpty(self) -> bool:
"""
Empty query
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Last(self) -> Interface_Check:
"""
Last item access
"""
def Length(self) -> int:
"""
Number of items
"""
def Lower(self) -> int:
"""
Method for consistency with other collections.
"""
@overload
def Prepend(self,theSeq : Interface_SequenceOfCheck) -> None:
"""
Prepend one item
Prepend another sequence (making it empty)
"""
@overload
def Prepend(self,theItem : Interface_Check) -> None: ...
@overload
def Remove(self,theIndex : int) -> None:
"""
Remove one item
Remove range of items
"""
@overload
def Remove(self,theFromIndex : int,theToIndex : int) -> None: ...
def Reverse(self) -> None:
"""
Reverse sequence
"""
def Sequence(self) -> Interface_SequenceOfCheck:
"""
None
"""
def SetValue(self,theIndex : int,theItem : Interface_Check) -> None:
"""
Set item value by theIndex
"""
def Size(self) -> int:
"""
Number of items
"""
def Split(self,theIndex : int,theSeq : Interface_SequenceOfCheck) -> None:
"""
Split in two sequences
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Upper(self) -> int:
"""
Method for consistency with other collections.
"""
def Value(self,theIndex : int) -> Interface_Check:
"""
Constant item access by theIndex
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> Interface_Check:
"""
Constant operator()
Variable operator()
"""
@overload
def __init__(self,theOther : Interface_SequenceOfCheck) -> None: ...
@overload
def __init__(self) -> None: ...
def __iter__(self) -> Iterator[Interface_Check]: ...
def __len__(self) -> int: ...
@staticmethod
def delNode_s(theNode : NCollection_SeqNode,theAl : OCP.NCollection.NCollection_BaseAllocator) -> None:
"""
Static deleter to be passed to BaseSequence
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_ShareFlags():
"""
This class only says for each Entity of a Model, if it is Shared or not by one or more other(s) of this Model It uses the General Service "Shared".
"""
def IsShared(self,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if <ent> is Shared by one or more other Entity(ies) of the Model
"""
def Model(self) -> Interface_InterfaceModel:
"""
Returns the Model used for the evaluation
"""
def NbRoots(self) -> int:
"""
Returns the count of root entities
"""
def Root(self,num : int=1) -> OCP.Standard.Standard_Transient:
"""
Returns a root entity according its rank in the list of roots By default, it returns the first one
"""
def RootEntities(self) -> Interface_EntityIterator:
"""
Returns the Entities which are not Shared (see their flags)
"""
@overload
def __init__(self,amodel : Interface_InterfaceModel,gtool : Interface_GTool) -> None: ...
@overload
def __init__(self,agraph : Interface_Graph) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,protocol : Interface_Protocol) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,lib : Interface_GeneralLib) -> None: ...
pass
class Interface_ShareTool():
"""
Builds the Graph of Dependencies, from the General Service "Shared" -> builds for each Entity of a Model, the Shared and Sharing Lists, and gives access to them. Allows to complete with Implied References (which are not regarded as Shared Entities, but are nevertheless Referenced), this can be useful for Reference Checking
"""
def All(self,ent : OCP.Standard.Standard_Transient,rootlast : bool=True) -> Interface_EntityIterator:
"""
Returns the complete list of entities shared by <ent> at any level, including <ent> itself If <ent> is the Model, considers the concatenation of AllShared for each root If <rootlast> is True (D), the list starts with lower level entities and ends by the root. Else, the root is first and the lower level entities are at end
"""
def Graph(self) -> Interface_Graph:
"""
Returns the data used by the ShareTool to work Can then be used directly (read only)
"""
def IsShared(self,ent : OCP.Standard.Standard_Transient) -> bool:
"""
Returns True if <ent> is Shared by other Entities in the Model
"""
def Model(self) -> Interface_InterfaceModel:
"""
Returns the Model used for Creation (directly or for Graph)
"""
def NbTypedSharings(self,ent : OCP.Standard.Standard_Transient,atype : OCP.Standard.Standard_Type) -> int:
"""
Returns the count of Sharing Entities of an Entity, which are Kind of a given Type
"""
def Print(self,iter : Interface_EntityIterator,S : io.BytesIO) -> None:
"""
Utility method which Prints the content of an iterator (by their Numbers)
"""
def RootEntities(self) -> Interface_EntityIterator:
"""
Returns the Entities which are not Shared (their Sharing List is empty) in the Model
"""
def Shareds(self,ent : OCP.Standard.Standard_Transient) -> Interface_EntityIterator:
"""
Returns the List of Entities Shared by a given Entity <ent>
"""
def Sharings(self,ent : OCP.Standard.Standard_Transient) -> Interface_EntityIterator:
"""
Returns the List of Entities Sharing a given Entity <ent>
"""
def TypedSharing(self,ent : OCP.Standard.Standard_Transient,atype : OCP.Standard.Standard_Type) -> OCP.Standard.Standard_Transient:
"""
Returns the Sharing Entity of an Entity, which is Kind of a given Type. Allows to access a Sharing Entity of a given type when there is one and only one (current case)
"""
@overload
def __init__(self,agraph : Interface_Graph) -> None: ...
@overload
def __init__(self,ahgraph : Interface_HGraph) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,protocol : Interface_Protocol) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,lib : Interface_GeneralLib) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel) -> None: ...
@overload
def __init__(self,amodel : Interface_InterfaceModel,gtool : Interface_GTool) -> None: ...
pass
class Interface_SignLabel():
"""
Signature to give the Label from the ModelSignature to give the Label from the ModelSignature to give the Label from the Model
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Name(self) -> str:
"""
Returns "Entity Label"
"""
def Text(self,ent : OCP.Standard.Standard_Transient,context : OCP.Standard.Standard_Transient) -> OCP.TCollection.TCollection_AsciiString:
"""
Considers context as an InterfaceModel and returns the Label computed by it
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_SignType():
"""
Provides the basic service to get a type name, according to a norm It can be used for other classes (general signatures ...)Provides the basic service to get a type name, according to a norm It can be used for other classes (general signatures ...)Provides the basic service to get a type name, according to a norm It can be used for other classes (general signatures ...)
"""
@staticmethod
def ClassName_s(typnam : str) -> str:
"""
From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Text(self,ent : OCP.Standard.Standard_Transient,context : OCP.Standard.Standard_Transient) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns an identification of the Signature (a word), given at initialization time Specialised to consider context as an InterfaceModel
"""
def Value(self,ent : OCP.Standard.Standard_Transient,model : Interface_InterfaceModel) -> str:
"""
Returns the Signature for a Transient object. It is specific of each sub-class of Signature. For a Null Handle, it should provide "" It can work with the model which contains the entity
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_TypedValue():
"""
Now strictly equivalent to TypedValue from MoniTool, except for ParamType which remains for compatibility reasonsNow strictly equivalent to TypedValue from MoniTool, except for ParamType which remains for compatibility reasonsNow strictly equivalent to TypedValue from MoniTool, except for ParamType which remains for compatibility reasons
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def ParamTypeToValueType_s(typ : Interface_ParamType) -> MoniTool_ValueType:
"""
Correspondence ParamType from Interface to ValueType from MoniTool
"""
def Type(self) -> Interface_ParamType:
"""
Returns the type I.E. calls ValueType then makes correspondence between ParamType from Interface (which remains for compatibility reasons) and ValueType from MoniTool
"""
@staticmethod
def ValueTypeToParamType_s(typ : MoniTool_ValueType) -> Interface_ParamType:
"""
Correspondence ParamType from Interface to ValueType from MoniTool
"""
def __init__(self,name : str,type : Interface_ParamType=Interface_ParamType.Interface_ParamText,init : str='') -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_Static(Interface_TypedValue):
"""
This class gives a way to manage meaningful static variables, used as "global" parameters in various procedures.This class gives a way to manage meaningful static variables, used as "global" parameters in various procedures.This class gives a way to manage meaningful static variables, used as "global" parameters in various procedures.
"""
@staticmethod
def CDef_s(name : str,part : str) -> str:
"""
Returns a part of the definition of a Static, as a CString The part is designated by its name, as a CString If the required value is not a string, it is converted to a CString then returned If <name> is not present, or <part> not defined for <name>, this function returns an empty string
"""
@staticmethod
def CVal_s(name : str) -> str:
"""
Returns the value of the parameter identified by the string name. If the specified parameter does not exist, an empty string is returned. Example Interface_Static::CVal("write.step.schema"); which could return: "AP214"
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Family(self) -> str:
"""
Returns the family. It can be : a resource name for applis, an internal name between : $e (environment variables), $l (other, purely local)
"""
@staticmethod
def FillMap_s(theMap : OCP.Resource.Resource_DataMapOfAsciiStringAsciiString) -> None:
"""
Fills given string-to-string map with all static data
"""
@staticmethod
def IDef_s(name : str,part : str) -> int:
"""
Returns a part of the definition of a Static, as an Integer The part is designated by its name, as a CString If the required value is not a string, returns zero For a Boolean, 0 for false, 1 for true If <name> is not present, or <part> not defined for <name>, this function returns zero
"""
@staticmethod
def IVal_s(name : str) -> int:
"""
Returns the integer value of the translation parameter identified by the string name. Returns the value 0 if the parameter does not exist. Example Interface_Static::IVal("write.step.schema"); which could return: 3
"""
@staticmethod
@overload
def Init_s(family : str,name : str,type : Interface_ParamType,init : str='') -> bool:
"""
Declares a new Static (by calling its constructor) If this name is already taken, does nothing and returns False Else, creates it and returns True For additional definitions, get the Static then edit it
As Init with ParamType, but type is given as a character This allows a simpler call Types : 'i' Integer, 'r' Real, 't' Text, 'e' Enum, 'o' Object '=' for same definition as, <init> gives the initial Static Returns False if <type> does not match this list
"""
@staticmethod
@overload
def Init_s(family : str,name : str,type : str,init : str='') -> bool: ...
@staticmethod
def IsPresent_s(name : str) -> bool:
"""
Returns True if a Static named <name> is present, False else
"""
@staticmethod
def IsSet_s(name : str,proper : bool=True) -> bool:
"""
Returns True if <name> is present AND set <proper> True (D) : considers this item only <proper> False : if not set and attached to a wild-card, considers this wild-card
"""
@staticmethod
def IsUpdated_s(name : str) -> bool:
"""
Returns the status "uptodate" from a Static Returns False if <name> is not present
"""
@staticmethod
def Items_s(mode : int=0,criter : str='') -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns a list of names of statics : <mode> = 0 (D) : criter is for family <mode> = 1 : criter is regexp on names, takes final items (ignore wild cards) <mode> = 2 : idem but take only wilded, not final items <mode> = 3 : idem, take all items matching criter idem + 100 : takes only non-updated items idem + 200 : takes only updated items criter empty (D) : returns all names else returns names which match the given criter Remark : families beginning by '$' are not listed by criter "" they are listed only by criter "$"
"""
@staticmethod
def ParamTypeToValueType_s(typ : Interface_ParamType) -> MoniTool_ValueType:
"""
Correspondence ParamType from Interface to ValueType from MoniTool
"""
def PrintStatic(self,S : io.BytesIO) -> None:
"""
Writes the properties of a parameter in the diagnostic file. These include: - Name - Family, - Wildcard (if it has one) - Current status (empty string if it was updated or if it is the original one) - Value
"""
@staticmethod
def RVal_s(name : str) -> float:
"""
Returns the value of a static translation parameter identified by the string name. Returns the value 0.0 if the parameter does not exist.
"""
@staticmethod
def SetCVal_s(name : str,val : str) -> bool:
"""
Modifies the value of the parameter identified by name. The modification is specified by the string val. false is returned if the parameter does not exist. Example Interface_Static::SetCVal ("write.step.schema","AP203") This syntax specifies a switch from the default STEP 214 mode to STEP 203 mode.
"""
@staticmethod
def SetIVal_s(name : str,val : int) -> bool:
"""
Modifies the value of the parameter identified by name. The modification is specified by the integer value val. false is returned if the parameter does not exist. Example Interface_Static::SetIVal ("write.step.schema", 3) This syntax specifies a switch from the default STEP 214 mode to STEP 203 mode.S
"""
@staticmethod
def SetRVal_s(name : str,val : float) -> bool:
"""
Modifies the value of a translation parameter. false is returned if the parameter does not exist. The modification is specified by the real number value val.
"""
def SetUptodate(self) -> None:
"""
Records a Static has "uptodate", i.e. its value has been taken into account by a reinitialisation procedure This flag is reset at each successful SetValue
"""
def SetWild(self,wildcard : Interface_Static) -> None:
"""
Sets a "wild-card" static : its value will be considered if <me> is not properly set. (reset by set a null one)
"""
@staticmethod
def Standards_s() -> None:
"""
Initializes all standard static parameters, which can be used by every function. statics specific of a norm or a function must be defined around it
"""
@staticmethod
def Static_s(name : str) -> Interface_Static:
"""
Returns a Static from its name. Null Handle if not present
"""
def Type(self) -> Interface_ParamType:
"""
Returns the type I.E. calls ValueType then makes correspondence between ParamType from Interface (which remains for compatibility reasons) and ValueType from MoniTool
"""
@staticmethod
def Update_s(name : str) -> bool:
"""
Sets a Static to be "uptodate" Returns False if <name> is not present This status can be used by a reinitialisation procedure to rerun if a value has been changed
"""
def UpdatedStatus(self) -> bool:
"""
Returns the status "uptodate"
"""
@staticmethod
def ValueTypeToParamType_s(typ : MoniTool_ValueType) -> Interface_ParamType:
"""
Correspondence ParamType from Interface to ValueType from MoniTool
"""
def Wild(self) -> Interface_Static:
"""
Returns the wildcard static, which can be (is most often) null
"""
@overload
def __init__(self,family : str,name : str,other : Interface_Static) -> None: ...
@overload
def __init__(self,family : str,name : str,type : Interface_ParamType=Interface_ParamType.Interface_ParamText,init : str='') -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_UndefinedContent(OCP.Standard.Standard_Transient):
"""
Defines resources for an "Undefined Entity" : such an Entity is used to describe an Entity which complies with the Norm, but of an Unknown Type : hence it is kept under a literal form (avoiding to loose data). UndefinedContent offers a way to store a list of Parameters, as literals or references to other EntitiesDefines resources for an "Undefined Entity" : such an Entity is used to describe an Entity which complies with the Norm, but of an Unknown Type : hence it is kept under a literal form (avoiding to loose data). UndefinedContent offers a way to store a list of Parameters, as literals or references to other EntitiesDefines resources for an "Undefined Entity" : such an Entity is used to describe an Entity which complies with the Norm, but of an Unknown Type : hence it is kept under a literal form (avoiding to loose data). UndefinedContent offers a way to store a list of Parameters, as literals or references to other Entities
"""
def AddEntity(self,ptype : Interface_ParamType,ent : OCP.Standard.Standard_Transient) -> None:
"""
Adds a Parameter which references an Entity
"""
def AddLiteral(self,ptype : Interface_ParamType,val : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Adds a literal Parameter to the list
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def EntityList(self) -> Interface_EntityList:
"""
Returns globally the list of param entities. Note that it can be used as shared entity list for the UndefinedEntity
"""
def GetFromAnother(self,other : Interface_UndefinedContent,TC : Interface_CopyTool) -> None:
"""
Copies contents of undefined entities; deigned to be called by GetFromAnother method from Undefined entity of each Interface (the basic operation is the same regardless the norm)
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsParamEntity(self,num : int) -> bool:
"""
Returns True if a Parameter is recorded as an entity Error if num is not between 1 and NbParams
"""
def NbLiterals(self) -> int:
"""
Gives count of Literal Parameters
"""
def NbParams(self) -> int:
"""
Gives count of recorded parameters
"""
def ParamData(self,num : int,ptype : Interface_ParamType,ent : OCP.Standard.Standard_Transient,val : OCP.TCollection.TCollection_HAsciiString) -> bool:
"""
Returns data of a Parameter : its type, and the entity if it designates en entity ("ent") or its literal value else ("str") Returned value (Boolean) : True if it is an Entity, False else
"""
def ParamEntity(self,num : int) -> OCP.Standard.Standard_Transient:
"""
Returns Entity corresponding to a Param, given its rank
"""
def ParamType(self,num : int) -> Interface_ParamType:
"""
Returns the ParamType of a Param, given its rank Error if num is not between 1 and NbParams
"""
def ParamValue(self,num : int) -> OCP.TCollection.TCollection_HAsciiString:
"""
Returns literal value of a Parameter, given its rank
"""
def RemoveParam(self,num : int) -> None:
"""
Removes a Parameter given its rank
"""
def Reservate(self,nb : int,nblit : int) -> None:
"""
Manages reservation for parameters (internal use) (nb : total count of parameters, nblit : count of literals)
"""
@overload
def SetEntity(self,num : int,ent : OCP.Standard.Standard_Transient) -> None:
"""
Sets a new value for the Parameter <num>, to reference an Entity. To simply change the Entity, see the variant below
Changes the Entity referenced by the Parameter <num> (with same ParamType)
"""
@overload
def SetEntity(self,num : int,ptype : Interface_ParamType,ent : OCP.Standard.Standard_Transient) -> None: ...
def SetLiteral(self,num : int,ptype : Interface_ParamType,val : OCP.TCollection.TCollection_HAsciiString) -> None:
"""
Sets a new value for the Parameter <num>, to a literal value (if it referenced formerly an Entity, this Entity is removed)
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Interface_VectorOfFileParameter():
"""
Class NCollection_DynamicArray (dynamic array of objects)
"""
def Assign(self,theOther : Interface_VectorOfFileParameter,theOwnAllocator : bool=True) -> Interface_VectorOfFileParameter:
"""
Assignment to the collection of the same type
"""
def Clear(self,theReleaseMemory : bool=False) -> None:
"""
None
"""
def EraseLast(self) -> None:
"""
None
"""
def IsEmpty(self) -> bool:
"""
Empty query
"""
def Length(self) -> int:
"""
Total number of items
"""
def Lower(self) -> int:
"""
Method for consistency with other collections.
"""
def SetIncrement(self,theIncrement : int) -> None:
"""
None
"""
def Size(self) -> int:
"""
Total number of items in the vector
"""
def Upper(self) -> int:
"""
Method for consistency with other collections.
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> Interface_FileParameter: ...
@overload
def __init__(self,theIncrement : int,theAllocator : Any) -> None: ...
@overload
def __init__(self,theOther : Interface_VectorOfFileParameter) -> None: ...
@overload
def __init__(self,theIncrement : int=256) -> None: ...
@overload
def __init__(self,theIncrement : int,theAllocator : OCP.NCollection.NCollection_BaseAllocator) -> None: ...
def __iter__(self) -> Iterator[Interface_FileParameter]: ...
def __len__(self) -> int: ...
pass
Interface_CheckAny: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckAny: 3>
Interface_CheckFail: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckFail: 2>
Interface_CheckMessage: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckMessage: 4>
Interface_CheckNoFail: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckNoFail: 5>
Interface_CheckOK: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckOK: 0>
Interface_CheckWarning: OCP.Interface.Interface_CheckStatus # value = <Interface_CheckStatus.Interface_CheckWarning: 1>
Interface_DataFail: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_DataFail: 4>
Interface_DataWarning: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_DataWarning: 3>
Interface_LoadFail: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_LoadFail: 2>
Interface_LoadWarning: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_LoadWarning: 1>
Interface_ParamBinary: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamBinary: 10>
Interface_ParamEnum: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamEnum: 6>
Interface_ParamHexa: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamHexa: 9>
Interface_ParamIdent: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamIdent: 3>
Interface_ParamInteger: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamInteger: 1>
Interface_ParamLogical: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamLogical: 7>
Interface_ParamMisc: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamMisc: 0>
Interface_ParamReal: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamReal: 2>
Interface_ParamSub: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamSub: 8>
Interface_ParamText: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamText: 5>
Interface_ParamVoid: OCP.Interface.Interface_ParamType # value = <Interface_ParamType.Interface_ParamVoid: 4>
Interface_StateOK: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_StateOK: 0>
Interface_StateUnknown: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_StateUnknown: 6>
Interface_StateUnloaded: OCP.Interface.Interface_DataState # value = <Interface_DataState.Interface_StateUnloaded: 5>
|