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
|
import OCP.TFunction
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.NCollection
import OCP.TColStd
import OCP.Standard
import OCP.TDF
import io
__all__ = [
"TFunction_Array1OfDataMapOfGUIDDriver",
"TFunction_DataMapOfLabelListOfLabel",
"TFunction_DoubleMapOfIntegerLabel",
"TFunction_Driver",
"TFunction_DriverTable",
"TFunction_ExecutionStatus",
"TFunction_Function",
"TFunction_GraphNode",
"TFunction_HArray1OfDataMapOfGUIDDriver",
"TFunction_IFunction",
"TFunction_Iterator",
"TFunction_Logbook",
"TFunction_Scope",
"TFunction_ES_Executing",
"TFunction_ES_Failed",
"TFunction_ES_NotExecuted",
"TFunction_ES_Succeeded",
"TFunction_ES_WrongDefinition"
]
class TFunction_Array1OfDataMapOfGUIDDriver():
"""
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 : TFunction_Array1OfDataMapOfGUIDDriver) -> TFunction_Array1OfDataMapOfGUIDDriver:
"""
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 : Any) -> 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 : TFunction_Array1OfDataMapOfGUIDDriver) -> TFunction_Array1OfDataMapOfGUIDDriver:
"""
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 : Any) -> 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) -> Any: ...
@overload
def __init__(self,theOther : TFunction_Array1OfDataMapOfGUIDDriver) -> None: ...
@overload
def __init__(self,theAlloc : Any,theLower : int,theUpper : int) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int) -> None: ...
@overload
def __init__(self) -> None: ...
def __iter__(self) -> Any: ...
def __len__(self) -> int: ...
pass
class TFunction_DataMapOfLabelListOfLabel(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 : TFunction_DataMapOfLabelListOfLabel) -> TFunction_DataMapOfLabelListOfLabel:
"""
Assignment. This method does not change the internal allocator.
"""
def Bind(self,theKey : OCP.TDF.TDF_Label,theItem : OCP.TDF.TDF_LabelList) -> bool:
"""
Bind binds Item to Key in map.
"""
def Bound(self,theKey : OCP.TDF.TDF_Label,theItem : OCP.TDF.TDF_LabelList) -> OCP.TDF.TDF_LabelList:
"""
Bound binds Item to Key in map.
"""
def ChangeFind(self,theKey : OCP.TDF.TDF_Label) -> OCP.TDF.TDF_LabelList:
"""
ChangeFind returns mofifiable Item by Key. Raises if Key was not bound
"""
def ChangeSeek(self,theKey : OCP.TDF.TDF_Label) -> OCP.TDF.TDF_LabelList:
"""
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 : TFunction_DataMapOfLabelListOfLabel) -> 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.TDF.TDF_Label) -> OCP.TDF.TDF_LabelList:
"""
Find returns the Item for Key. Raises if Key was not bound
Find Item for key with copying.
"""
@overload
def Find(self,theKey : OCP.TDF.TDF_Label,theValue : OCP.TDF.TDF_LabelList) -> bool: ...
def IsBound(self,theKey : OCP.TDF.TDF_Label) -> bool:
"""
IsBound
"""
def IsEmpty(self) -> bool:
"""
IsEmpty
"""
def NbBuckets(self) -> int:
"""
NbBuckets
"""
def ReSize(self,N : int) -> None:
"""
ReSize
"""
def Seek(self,theKey : OCP.TDF.TDF_Label) -> OCP.TDF.TDF_LabelList:
"""
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.TDF.TDF_Label) -> bool:
"""
UnBind removes Item Key pair from map
"""
def __call__(self,theKey : OCP.TDF.TDF_Label) -> OCP.TDF.TDF_LabelList: ...
@overload
def __init__(self,theOther : TFunction_DataMapOfLabelListOfLabel) -> None: ...
@overload
def __init__(self,theNbBuckets : int,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None: ...
@overload
def __init__(self) -> None: ...
def __iter__(self) -> Iterator[OCP.TDF.TDF_LabelList]: ...
def __len__(self) -> int: ...
pass
class TFunction_DoubleMapOfIntegerLabel(OCP.NCollection.NCollection_BaseMap):
"""
Purpose: The DoubleMap is used to bind pairs (Key1,Key2) and retrieve them in linear time.
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
def AreBound(self,theKey1 : int,theKey2 : OCP.TDF.TDF_Label) -> bool:
"""
* AreBound
"""
def Assign(self,theOther : TFunction_DoubleMapOfIntegerLabel) -> TFunction_DoubleMapOfIntegerLabel:
"""
Assignment. This method does not change the internal allocator.
"""
def Bind(self,theKey1 : int,theKey2 : OCP.TDF.TDF_Label) -> None:
"""
Bind
"""
@overload
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator) -> 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,doReleaseMemory : bool=False) -> None: ...
def Exchange(self,theOther : TFunction_DoubleMapOfIntegerLabel) -> 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 Find1(self,theKey1 : int) -> OCP.TDF.TDF_Label:
"""
Find the Key1 and return Key2 value. Raises an exception if Key1 was not bound.
Find the Key1 and return Key2 value (by copying its value).
"""
@overload
def Find1(self,theKey1 : int,theKey2 : OCP.TDF.TDF_Label) -> bool: ...
@overload
def Find2(self,theKey2 : OCP.TDF.TDF_Label,theKey1 : int) -> bool:
"""
Find the Key2 and return Key1 value. Raises an exception if Key2 was not bound.
Find the Key2 and return Key1 value (by copying its value).
"""
@overload
def Find2(self,theKey2 : OCP.TDF.TDF_Label) -> int: ...
def IsBound1(self,theKey1 : int) -> bool:
"""
IsBound1
"""
def IsBound2(self,theKey2 : OCP.TDF.TDF_Label) -> bool:
"""
IsBound2
"""
def IsEmpty(self) -> bool:
"""
IsEmpty
"""
def NbBuckets(self) -> int:
"""
NbBuckets
"""
def ReSize(self,N : int) -> None:
"""
ReSize
"""
def Seek1(self,theKey1 : int) -> OCP.TDF.TDF_Label:
"""
Find the Key1 and return pointer to Key2 or NULL if Key1 is not bound.
"""
def Seek2(self,theKey2 : OCP.TDF.TDF_Label) -> int:
"""
Find the Key2 and return pointer to Key1 or NULL if not bound.
"""
def Size(self) -> int:
"""
Size
"""
def Statistics(self,S : io.BytesIO) -> None:
"""
Statistics
"""
def UnBind1(self,theKey1 : int) -> bool:
"""
UnBind1
"""
def UnBind2(self,theKey2 : OCP.TDF.TDF_Label) -> bool:
"""
UnBind2
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theNbBuckets : int,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None: ...
@overload
def __init__(self,theOther : TFunction_DoubleMapOfIntegerLabel) -> None: ...
def __len__(self) -> int: ...
pass
class TFunction_Driver(OCP.Standard.Standard_Transient):
"""
This driver class provide services around function execution. One instance of this class is built for the whole session. The driver is bound to the DriverGUID in the DriverTable class. It allows you to create classes which inherit from this abstract class. These subclasses identify the various algorithms which can be applied to the data contained in the attributes of sub-labels of a model. A single instance of this class and each of its subclasses is built for the whole session.This driver class provide services around function execution. One instance of this class is built for the whole session. The driver is bound to the DriverGUID in the DriverTable class. It allows you to create classes which inherit from this abstract class. These subclasses identify the various algorithms which can be applied to the data contained in the attributes of sub-labels of a model. A single instance of this class and each of its subclasses is built for the whole session.This driver class provide services around function execution. One instance of this class is built for the whole session. The driver is bound to the DriverGUID in the DriverTable class. It allows you to create classes which inherit from this abstract class. These subclasses identify the various algorithms which can be applied to the data contained in the attributes of sub-labels of a model. A single instance of this class and each of its subclasses is built for the whole session.
"""
def Arguments(self,args : OCP.TDF.TDF_LabelList) -> None:
"""
The method fills-in the list by labels, where the arguments of the function are located.
"""
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 Execute(self,log : TFunction_Logbook) -> int:
"""
Executes the function in this function driver and puts the impacted labels in the logbook log. arguments & results of functions ================================
"""
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,L : OCP.TDF.TDF_Label) -> None:
"""
Initializes the label L for this function prior to its execution.
"""
@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 Label(self) -> OCP.TDF.TDF_Label:
"""
Returns the label of the driver for this function.
Returns the label of the driver for this function.
"""
def MustExecute(self,log : TFunction_Logbook) -> bool:
"""
Analyzes the labels in the logbook log. Returns true if attributes have been modified. If the function label itself has been modified, the function must be executed.
"""
def Results(self,res : OCP.TDF.TDF_LabelList) -> None:
"""
The method fills-in the list by labels, where the results of the function are located.
"""
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 Validate(self,log : TFunction_Logbook) -> Any:
"""
Validates labels of a function in <log>. This function is the one initialized in this function driver. Warning In regeneration mode, the solver must call this method even if the function is not executed. execution of function =====================
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class TFunction_DriverTable(OCP.Standard.Standard_Transient):
"""
A container for instances of drivers. You create a new instance of TFunction_Driver and use the method AddDriver to load it into the driver table.A container for instances of drivers. You create a new instance of TFunction_Driver and use the method AddDriver to load it into the driver table.A container for instances of drivers. You create a new instance of TFunction_Driver and use the method AddDriver to load it into the driver table.
"""
def AddDriver(self,guid : OCP.Standard.Standard_GUID,driver : TFunction_Driver,thread : int=0) -> bool:
"""
Returns true if the driver has been added successfully to the driver table.
"""
def Clear(self) -> None:
"""
Removes all drivers. Returns true if the driver has been removed successfully.
"""
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 Dump(self,anOS : io.BytesIO) -> io.BytesIO:
"""
None
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def FindDriver(self,guid : OCP.Standard.Standard_GUID,driver : TFunction_Driver,thread : int=0) -> bool:
"""
Returns true if the driver was found.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
@staticmethod
def Get_s() -> TFunction_DriverTable:
"""
Returns the driver table. If a driver does not exist, creates it.
"""
def HasDriver(self,guid : OCP.Standard.Standard_GUID,thread : int=0) -> bool:
"""
Returns true if the driver exists in the driver table.
"""
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 RemoveDriver(self,guid : OCP.Standard.Standard_GUID,thread : int=0) -> bool:
"""
Removes a driver with the given GUID. Returns true if the driver has been removed successfully.
"""
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 TFunction_ExecutionStatus():
"""
None
Members:
TFunction_ES_WrongDefinition
TFunction_ES_NotExecuted
TFunction_ES_Executing
TFunction_ES_Succeeded
TFunction_ES_Failed
"""
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
"""
TFunction_ES_Executing: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_Executing: 2>
TFunction_ES_Failed: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_Failed: 4>
TFunction_ES_NotExecuted: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_NotExecuted: 1>
TFunction_ES_Succeeded: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_Succeeded: 3>
TFunction_ES_WrongDefinition: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_WrongDefinition: 0>
__entries: dict # value = {'TFunction_ES_WrongDefinition': (<TFunction_ExecutionStatus.TFunction_ES_WrongDefinition: 0>, None), 'TFunction_ES_NotExecuted': (<TFunction_ExecutionStatus.TFunction_ES_NotExecuted: 1>, None), 'TFunction_ES_Executing': (<TFunction_ExecutionStatus.TFunction_ES_Executing: 2>, None), 'TFunction_ES_Succeeded': (<TFunction_ExecutionStatus.TFunction_ES_Succeeded: 3>, None), 'TFunction_ES_Failed': (<TFunction_ExecutionStatus.TFunction_ES_Failed: 4>, None)}
__members__: dict # value = {'TFunction_ES_WrongDefinition': <TFunction_ExecutionStatus.TFunction_ES_WrongDefinition: 0>, 'TFunction_ES_NotExecuted': <TFunction_ExecutionStatus.TFunction_ES_NotExecuted: 1>, 'TFunction_ES_Executing': <TFunction_ExecutionStatus.TFunction_ES_Executing: 2>, 'TFunction_ES_Succeeded': <TFunction_ExecutionStatus.TFunction_ES_Succeeded: 3>, 'TFunction_ES_Failed': <TFunction_ExecutionStatus.TFunction_ES_Failed: 4>}
pass
class TFunction_Function(OCP.TDF.TDF_Attribute, OCP.Standard.Standard_Transient):
"""
Provides the following two services - a link to an evaluation driver - the means of providing a link between a function and an evaluation driver.Provides the following two services - a link to an evaluation driver - the means of providing a link between a function and an evaluation driver.Provides the following two services - a link to an evaluation driver - the means of providing a link between a function and an evaluation driver.
"""
def AddAttribute(self,other : OCP.TDF.TDF_Attribute) -> None:
"""
Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.
"""
def AfterAddition(self) -> None:
"""
Something to do after adding an Attribute to a label.
"""
def AfterResume(self) -> None:
"""
Something to do after resuming an Attribute from a label.
"""
def AfterRetrieval(self,forceIt : bool=False) -> bool:
"""
Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def AfterUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def Backup(self) -> None:
"""
Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
"""
def BackupCopy(self) -> OCP.TDF.TDF_Attribute:
"""
Copies the attribute contents into a new other attribute. It is used by Backup().
"""
def BeforeCommitTransaction(self) -> None:
"""
A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
"""
def BeforeForget(self) -> None:
"""
Something to do before forgetting an Attribute to a label.
"""
def BeforeRemoval(self) -> None:
"""
Something to do before removing an Attribute from a label.
"""
def BeforeUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
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 DeltaOnAddition(self) -> OCP.TDF.TDF_DeltaOnAddition:
"""
Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
"""
def DeltaOnForget(self) -> OCP.TDF.TDF_DeltaOnForget:
"""
Makes an AttributeDelta because <me> has been forgotten.
"""
@overload
def DeltaOnModification(self,anOldAttribute : OCP.TDF.TDF_Attribute) -> OCP.TDF.TDF_DeltaOnModification:
"""
Makes a DeltaOnModification between <me> and <anOldAttribute.
Applies a DeltaOnModification to <me>.
"""
@overload
def DeltaOnModification(self,aDelta : OCP.TDF.TDF_DeltaOnModification) -> None: ...
def DeltaOnRemoval(self) -> OCP.TDF.TDF_DeltaOnRemoval:
"""
Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
"""
def DeltaOnResume(self) -> OCP.TDF.TDF_DeltaOnResume:
"""
Makes an AttributeDelta because <me> has been resumed.
"""
def Dump(self,anOS : io.BytesIO) -> io.BytesIO:
"""
None
"""
def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None:
"""
Dumps the content of me into the stream
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def ExtendedDump(self,anOS : io.BytesIO,aFilter : OCP.TDF.TDF_IDFilter,aMap : OCP.TDF.TDF_AttributeIndexedMap) -> None:
"""
Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
"""
def Failed(self) -> bool:
"""
Returns true if the execution failed
"""
def FindAttribute(self,anID : OCP.Standard.Standard_GUID,anAttribute : OCP.TDF.TDF_Attribute) -> bool:
"""
Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
"""
def Forget(self,aTransaction : int) -> None:
"""
Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
"""
def ForgetAllAttributes(self,clearChildren : bool=True) -> None:
"""
Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call
"""
def ForgetAttribute(self,aguid : OCP.Standard.Standard_GUID) -> bool:
"""
Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
"""
def GetDriverGUID(self) -> OCP.Standard.Standard_GUID:
"""
Returns the GUID for this function's driver.
"""
def GetFailure(self) -> int:
"""
Returns an index of failure if the execution of this function failed. If this integer value is 0, no failure has occurred. Implementation of Attribute methods: ===================================
"""
@staticmethod
def GetID_s() -> OCP.Standard.Standard_GUID:
"""
Returns the GUID for functions. Returns a function found on the label. Instance methods: ================
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def ID(self) -> OCP.Standard.Standard_GUID:
"""
None
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsAttribute(self,anID : OCP.Standard.Standard_GUID) -> bool:
"""
Returns true if it exists an associated attribute of <me> with <anID> as ID.
"""
def IsBackuped(self) -> bool:
"""
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
"""
def IsForgotten(self) -> bool:
"""
Returns true if the attribute forgotten status is set.
Returns true if the attribute forgotten status is set.
"""
@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 IsNew(self) -> bool:
"""
Returns true if the attribute has no backup
Returns true if the attribute has no backup
"""
def IsValid(self) -> bool:
"""
Returns true if the attribute is valid; i.e. not a backuped or removed one.
Returns true if the attribute is valid; i.e. not a backuped or removed one.
"""
def Label(self) -> OCP.TDF.TDF_Label:
"""
Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
"""
def NewEmpty(self) -> OCP.TDF.TDF_Attribute:
"""
None
"""
def Paste(self,into : OCP.TDF.TDF_Attribute,RT : OCP.TDF.TDF_RelocationTable) -> None:
"""
None
"""
def References(self,aDataSet : OCP.TDF.TDF_DataSet) -> None:
"""
None
"""
def Restore(self,with_ : OCP.TDF.TDF_Attribute) -> None:
"""
None
"""
def SetDriverGUID(self,guid : OCP.Standard.Standard_GUID) -> None:
"""
Sets the driver for this function as that identified by the GUID guid.
"""
def SetFailure(self,mode : int=0) -> None:
"""
Sets the failed index.
"""
@overload
def SetID(self) -> None:
"""
Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
Sets default ID defined in nested class (to be used for attributes having User ID feature).
"""
@overload
def SetID(self,arg1 : OCP.Standard.Standard_GUID) -> None: ...
@staticmethod
@overload
def Set_s(L : OCP.TDF.TDF_Label) -> TFunction_Function:
"""
Static methods: ============== Finds or Creates a function attribute on the label <L>. Returns the function attribute.
Finds or Creates a function attribute on the label <L>. Sets a driver ID to the function. Returns the function attribute.
"""
@staticmethod
@overload
def Set_s(L : OCP.TDF.TDF_Label,DriverID : OCP.Standard.Standard_GUID) -> TFunction_Function: ...
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 Transaction(self) -> int:
"""
Returns the transaction index in which the attribute has been created or modified.
Returns the transaction index in which the attribute has been created or modified.
"""
def UntilTransaction(self) -> int:
"""
Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
"""
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 TFunction_GraphNode(OCP.TDF.TDF_Attribute, OCP.Standard.Standard_Transient):
"""
Provides links between functions.Provides links between functions.Provides links between functions.
"""
def AddAttribute(self,other : OCP.TDF.TDF_Attribute) -> None:
"""
Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.
"""
@overload
def AddNext(self,func : OCP.TDF.TDF_Label) -> bool:
"""
Defines a reference to the function as a next one.
Defines a reference to the function as a next one.
"""
@overload
def AddNext(self,funcID : int) -> bool: ...
@overload
def AddPrevious(self,funcID : int) -> bool:
"""
Defines a reference to the function as a previous one.
Defines a reference to the function as a previous one.
"""
@overload
def AddPrevious(self,func : OCP.TDF.TDF_Label) -> bool: ...
def AfterAddition(self) -> None:
"""
Something to do after adding an Attribute to a label.
"""
def AfterResume(self) -> None:
"""
Something to do after resuming an Attribute from a label.
"""
def AfterRetrieval(self,forceIt : bool=False) -> bool:
"""
Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def AfterUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def Backup(self) -> None:
"""
Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
"""
def BackupCopy(self) -> OCP.TDF.TDF_Attribute:
"""
Copies the attribute contents into a new other attribute. It is used by Backup().
"""
def BeforeCommitTransaction(self) -> None:
"""
A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
"""
def BeforeForget(self) -> None:
"""
Something to do before forgetting an Attribute to a label.
"""
def BeforeRemoval(self) -> None:
"""
Something to do before removing an Attribute from a label.
"""
def BeforeUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
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 DeltaOnAddition(self) -> OCP.TDF.TDF_DeltaOnAddition:
"""
Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
"""
def DeltaOnForget(self) -> OCP.TDF.TDF_DeltaOnForget:
"""
Makes an AttributeDelta because <me> has been forgotten.
"""
@overload
def DeltaOnModification(self,anOldAttribute : OCP.TDF.TDF_Attribute) -> OCP.TDF.TDF_DeltaOnModification:
"""
Makes a DeltaOnModification between <me> and <anOldAttribute.
Applies a DeltaOnModification to <me>.
"""
@overload
def DeltaOnModification(self,aDelta : OCP.TDF.TDF_DeltaOnModification) -> None: ...
def DeltaOnRemoval(self) -> OCP.TDF.TDF_DeltaOnRemoval:
"""
Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
"""
def DeltaOnResume(self) -> OCP.TDF.TDF_DeltaOnResume:
"""
Makes an AttributeDelta because <me> has been resumed.
"""
def Dump(self,anOS : io.BytesIO) -> io.BytesIO:
"""
None
"""
def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None:
"""
Dumps the content of me into the stream
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def ExtendedDump(self,anOS : io.BytesIO,aFilter : OCP.TDF.TDF_IDFilter,aMap : OCP.TDF.TDF_AttributeIndexedMap) -> None:
"""
Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
"""
def FindAttribute(self,anID : OCP.Standard.Standard_GUID,anAttribute : OCP.TDF.TDF_Attribute) -> bool:
"""
Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
"""
def Forget(self,aTransaction : int) -> None:
"""
Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
"""
def ForgetAllAttributes(self,clearChildren : bool=True) -> None:
"""
Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call
"""
def ForgetAttribute(self,aguid : OCP.Standard.Standard_GUID) -> bool:
"""
Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
"""
@staticmethod
def GetID_s() -> OCP.Standard.Standard_GUID:
"""
Returns the GUID for GraphNode attribute. Instant methods =============== Constructor (empty).
"""
def GetNext(self) -> OCP.TColStd.TColStd_MapOfInteger:
"""
Returns a map of next functions.
"""
def GetPrevious(self) -> OCP.TColStd.TColStd_MapOfInteger:
"""
Returns a map of previous functions.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def GetStatus(self) -> TFunction_ExecutionStatus:
"""
Returns the execution status of the function.
"""
def ID(self) -> OCP.Standard.Standard_GUID:
"""
None
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsAttribute(self,anID : OCP.Standard.Standard_GUID) -> bool:
"""
Returns true if it exists an associated attribute of <me> with <anID> as ID.
"""
def IsBackuped(self) -> bool:
"""
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
"""
def IsForgotten(self) -> bool:
"""
Returns true if the attribute forgotten status is set.
Returns true if the attribute forgotten status is set.
"""
@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 IsNew(self) -> bool:
"""
Returns true if the attribute has no backup
Returns true if the attribute has no backup
"""
def IsValid(self) -> bool:
"""
Returns true if the attribute is valid; i.e. not a backuped or removed one.
Returns true if the attribute is valid; i.e. not a backuped or removed one.
"""
def Label(self) -> OCP.TDF.TDF_Label:
"""
Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
"""
def NewEmpty(self) -> OCP.TDF.TDF_Attribute:
"""
None
"""
def Paste(self,into : OCP.TDF.TDF_Attribute,RT : OCP.TDF.TDF_RelocationTable) -> None:
"""
None
"""
def References(self,aDataSet : OCP.TDF.TDF_DataSet) -> None:
"""
None
"""
def RemoveAllNext(self) -> None:
"""
Clears a map of next functions.
"""
def RemoveAllPrevious(self) -> None:
"""
Clears a map of previous functions.
"""
@overload
def RemoveNext(self,func : OCP.TDF.TDF_Label) -> bool:
"""
Removes a reference to the function as a next one.
Removes a reference to the function as a next one.
"""
@overload
def RemoveNext(self,funcID : int) -> bool: ...
@overload
def RemovePrevious(self,funcID : int) -> bool:
"""
Removes a reference to the function as a previous one.
Removes a reference to the function as a previous one.
"""
@overload
def RemovePrevious(self,func : OCP.TDF.TDF_Label) -> bool: ...
def Restore(self,with_ : OCP.TDF.TDF_Attribute) -> None:
"""
None
"""
@overload
def SetID(self) -> None:
"""
Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
Sets default ID defined in nested class (to be used for attributes having User ID feature).
"""
@overload
def SetID(self,arg1 : OCP.Standard.Standard_GUID) -> None: ...
def SetStatus(self,status : TFunction_ExecutionStatus) -> None:
"""
Defines an execution status for a function. Implementation of Attribute methods ===================================
"""
@staticmethod
def Set_s(L : OCP.TDF.TDF_Label) -> TFunction_GraphNode:
"""
Static methods ============== Finds or Creates a graph node attribute at the label <L>. Returns the attribute.
"""
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 Transaction(self) -> int:
"""
Returns the transaction index in which the attribute has been created or modified.
Returns the transaction index in which the attribute has been created or modified.
"""
def UntilTransaction(self) -> int:
"""
Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
"""
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 TFunction_HArray1OfDataMapOfGUIDDriver(TFunction_Array1OfDataMapOfGUIDDriver, OCP.Standard.Standard_Transient):
def Array1(self) -> TFunction_Array1OfDataMapOfGUIDDriver:
"""
None
"""
def Assign(self,theOther : TFunction_Array1OfDataMapOfGUIDDriver) -> TFunction_Array1OfDataMapOfGUIDDriver:
"""
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) -> TFunction_Array1OfDataMapOfGUIDDriver:
"""
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 : Any) -> 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 : TFunction_Array1OfDataMapOfGUIDDriver) -> TFunction_Array1OfDataMapOfGUIDDriver:
"""
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 : Any) -> 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) -> Any: ...
@overload
def __init__(self,theBegin : Any,theLower : int,theUpper : int,arg4 : bool) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int,theValue : Any) -> None: ...
@overload
def __init__(self,theOther : TFunction_Array1OfDataMapOfGUIDDriver) -> None: ...
@overload
def __init__(self,theLower : int,theUpper : int) -> None: ...
@overload
def __init__(self) -> None: ...
def __iter__(self) -> Any: ...
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 TFunction_IFunction():
"""
Interface class for usage of Function Mechanism
"""
def Arguments(self,args : OCP.TDF.TDF_LabelList) -> None:
"""
The method fills-in the list by labels, where the arguments of the function are located.
"""
@staticmethod
def DeleteFunction_s(L : OCP.TDF.TDF_Label) -> bool:
"""
Deletes a function attached to a label <L>. It deletes a TFunction_Function attribute and a TFunction_GraphNode. It deletes the functions from the scope of function of this document.
"""
def GetAllFunctions(self) -> TFunction_DoubleMapOfIntegerLabel:
"""
Returns the scope of all functions.
"""
def GetDriver(self,thread : int=0) -> TFunction_Driver:
"""
Returns a driver of the function.
"""
def GetGraphNode(self) -> TFunction_GraphNode:
"""
Returns a graph node of the function.
"""
def GetLogbook(self) -> TFunction_Logbook:
"""
Returns the Logbook - keeper of modifications.
"""
def GetNext(self,prev : OCP.TDF.TDF_LabelList) -> None:
"""
Returns a list of next functions.
"""
def GetPrevious(self,prev : OCP.TDF.TDF_LabelList) -> None:
"""
Returns a list of previous functions.
"""
def GetStatus(self) -> TFunction_ExecutionStatus:
"""
Returns the execution status of the function.
"""
def Init(self,L : OCP.TDF.TDF_Label) -> None:
"""
Initializes the interface by the label of function.
"""
def Label(self) -> OCP.TDF.TDF_Label:
"""
Returns a label of the function.
"""
@staticmethod
def NewFunction_s(L : OCP.TDF.TDF_Label,ID : OCP.Standard.Standard_GUID) -> bool:
"""
Sets a new function attached to a label <L> with <ID>. It creates a new TFunction_Function attribute initialized by the <ID>, a new TFunction_GraphNode with an empty list of dependencies and the status equal to TFunction_ES_WrongDefinition. It registers the function in the scope of functions for this document.
"""
def Results(self,res : OCP.TDF.TDF_LabelList) -> None:
"""
The method fills-in the list by labels, where the results of the function are located.
"""
def SetStatus(self,status : TFunction_ExecutionStatus) -> None:
"""
Defines an execution status for a function.
"""
def UpdateDependencies(self) -> bool:
"""
Updates the dependencies of this function only.
"""
@staticmethod
def UpdateDependencies_s(Access : OCP.TDF.TDF_Label) -> bool:
"""
Updates dependencies for all functions of the scope. It returns false in case of an error. An empty constructor.
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,L : OCP.TDF.TDF_Label) -> None: ...
pass
class TFunction_Iterator():
"""
Iterator of the graph of functions
"""
def Current(self) -> OCP.TDF.TDF_LabelList:
"""
Returns the current list of functions. If the iterator uses the execution status, the returned list contains only the functions with "not executed" status.
"""
def Dump(self,OS : io.BytesIO) -> io.BytesIO:
"""
None
"""
def GetMaxNbThreads(self) -> int:
"""
Analyses the graph of dependencies and returns maximum number of threads may be used to calculate the model.
"""
def GetStatus(self,func : OCP.TDF.TDF_Label) -> TFunction_ExecutionStatus:
"""
A help-function aimed to help the user to check the status of retrurned function. It calls TFunction_GraphNode::GetStatus() inside.
"""
def GetUsageOfExecutionStatus(self) -> bool:
"""
Returns usage of execution status by the iterator.
"""
def Init(self,Access : OCP.TDF.TDF_Label) -> None:
"""
Initializes the Iterator.
"""
def More(self) -> bool:
"""
Returns false if the graph of functions is fully iterated.
"""
def Next(self) -> None:
"""
Switches the iterator to the next list of current functions.
"""
def SetStatus(self,func : OCP.TDF.TDF_Label,status : TFunction_ExecutionStatus) -> None:
"""
A help-function aimed to help the user to change the execution status of a function. It calls TFunction_GraphNode::SetStatus() inside.
"""
def SetUsageOfExecutionStatus(self,usage : bool) -> None:
"""
Defines the mode of iteration - usage or not of the execution status. If the iterator takes into account the execution status, the method ::Current() returns only "not executed" functions while their status is not changed. If the iterator ignores the execution status, the method ::Current() returns the functions following their dependencies and ignoring the execution status.
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,Access : OCP.TDF.TDF_Label) -> None: ...
pass
class TFunction_Logbook(OCP.TDF.TDF_Attribute, OCP.Standard.Standard_Transient):
"""
This class contains information which is written and read during the solving process. Information is divided in three groups.This class contains information which is written and read during the solving process. Information is divided in three groups.This class contains information which is written and read during the solving process. Information is divided in three groups.
"""
def AddAttribute(self,other : OCP.TDF.TDF_Attribute) -> None:
"""
Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.
"""
def AfterAddition(self) -> None:
"""
Something to do after adding an Attribute to a label.
"""
def AfterResume(self) -> None:
"""
Something to do after resuming an Attribute from a label.
"""
def AfterRetrieval(self,forceIt : bool=False) -> bool:
"""
Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def AfterUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def Backup(self) -> None:
"""
Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
"""
def BackupCopy(self) -> OCP.TDF.TDF_Attribute:
"""
Copies the attribute contents into a new other attribute. It is used by Backup().
"""
def BeforeCommitTransaction(self) -> None:
"""
A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
"""
def BeforeForget(self) -> None:
"""
Something to do before forgetting an Attribute to a label.
"""
def BeforeRemoval(self) -> None:
"""
Something to do before removing an Attribute from a label.
"""
def BeforeUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def Clear(self) -> None:
"""
Clears this logbook to its default, empty state.
"""
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 DeltaOnAddition(self) -> OCP.TDF.TDF_DeltaOnAddition:
"""
Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
"""
def DeltaOnForget(self) -> OCP.TDF.TDF_DeltaOnForget:
"""
Makes an AttributeDelta because <me> has been forgotten.
"""
@overload
def DeltaOnModification(self,anOldAttribute : OCP.TDF.TDF_Attribute) -> OCP.TDF.TDF_DeltaOnModification:
"""
Makes a DeltaOnModification between <me> and <anOldAttribute.
Applies a DeltaOnModification to <me>.
"""
@overload
def DeltaOnModification(self,aDelta : OCP.TDF.TDF_DeltaOnModification) -> None: ...
def DeltaOnRemoval(self) -> OCP.TDF.TDF_DeltaOnRemoval:
"""
Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
"""
def DeltaOnResume(self) -> OCP.TDF.TDF_DeltaOnResume:
"""
Makes an AttributeDelta because <me> has been resumed.
"""
def Done(self,status : bool) -> None:
"""
Sets status of execution.
Sets status of execution.
"""
def Dump(self,anOS : io.BytesIO) -> io.BytesIO:
"""
Prints th data of the attributes (touched, impacted and valid labels).
"""
def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None:
"""
Dumps the content of me into the stream
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def ExtendedDump(self,anOS : io.BytesIO,aFilter : OCP.TDF.TDF_IDFilter,aMap : OCP.TDF.TDF_AttributeIndexedMap) -> None:
"""
Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
"""
def FindAttribute(self,anID : OCP.Standard.Standard_GUID,anAttribute : OCP.TDF.TDF_Attribute) -> bool:
"""
Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
"""
def Forget(self,aTransaction : int) -> None:
"""
Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
"""
def ForgetAllAttributes(self,clearChildren : bool=True) -> None:
"""
Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call
"""
def ForgetAttribute(self,aguid : OCP.Standard.Standard_GUID) -> bool:
"""
Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
"""
@staticmethod
def GetID_s() -> OCP.Standard.Standard_GUID:
"""
Returns the GUID for logbook attribute.
"""
def GetImpacted(self) -> OCP.TDF.TDF_LabelMap:
"""
Returns the map of impacted labels contained in this logbook.
Returns the map of impacted labels contained in this logbook.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def GetTouched(self) -> OCP.TDF.TDF_LabelMap:
"""
Returns the map of touched labels in this logbook. A touched label is the one modified by the end user.
Returns the map of touched labels in this logbook. A touched label is the one modified by the end user.
"""
@overload
def GetValid(self,Ls : OCP.TDF.TDF_LabelMap) -> None:
"""
None
Returns the map of valid labels in this logbook.
Returns the map of valid labels in this logbook.
"""
@overload
def GetValid(self) -> OCP.TDF.TDF_LabelMap: ...
def ID(self) -> OCP.Standard.Standard_GUID:
"""
Returns the ID of the attribute.
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsAttribute(self,anID : OCP.Standard.Standard_GUID) -> bool:
"""
Returns true if it exists an associated attribute of <me> with <anID> as ID.
"""
def IsBackuped(self) -> bool:
"""
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
"""
def IsDone(self) -> bool:
"""
Returns status of execution.
Returns status of execution.
"""
def IsEmpty(self) -> bool:
"""
None
"""
def IsForgotten(self) -> bool:
"""
Returns true if the attribute forgotten status is set.
Returns true if the attribute forgotten status is set.
"""
@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 IsModified(self,L : OCP.TDF.TDF_Label,WithChildren : bool=False) -> bool:
"""
Returns True if the label L is touched or impacted. This method is called by <TFunction_FunctionDriver::MustExecute>. If <WithChildren> is set to true, the method checks all the sublabels of <L> too.
"""
def IsNew(self) -> bool:
"""
Returns true if the attribute has no backup
Returns true if the attribute has no backup
"""
def IsValid(self) -> bool:
"""
Returns true if the attribute is valid; i.e. not a backuped or removed one.
Returns true if the attribute is valid; i.e. not a backuped or removed one.
"""
def Label(self) -> OCP.TDF.TDF_Label:
"""
Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
"""
def NewEmpty(self) -> OCP.TDF.TDF_Attribute:
"""
Returns a new empty instance of the attribute.
"""
def Paste(self,into : OCP.TDF.TDF_Attribute,RT : OCP.TDF.TDF_RelocationTable) -> None:
"""
Pastes the attribute to another label.
"""
def References(self,aDataSet : OCP.TDF.TDF_DataSet) -> None:
"""
Adds the first level referenced attributes and labels to <aDataSet>.
"""
def Restore(self,with_ : OCP.TDF.TDF_Attribute) -> None: ...
@overload
def SetID(self) -> None:
"""
Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
Sets default ID defined in nested class (to be used for attributes having User ID feature).
"""
@overload
def SetID(self,arg1 : OCP.Standard.Standard_GUID) -> None: ...
def SetImpacted(self,L : OCP.TDF.TDF_Label,WithChildren : bool=False) -> None:
"""
Sets the label L as an impacted label in this logbook. This method is called by execution of the function driver.
"""
def SetTouched(self,L : OCP.TDF.TDF_Label) -> None:
"""
Sets the label L as a touched label in this logbook. In other words, L is understood to have been modified by the end user.
Sets the label L as a touched label in this logbook. In other words, L is understood to have been modified by the end user.
"""
@overload
def SetValid(self,L : OCP.TDF.TDF_Label,WithChildren : bool=False) -> None:
"""
Sets the label L as a valid label in this logbook.
None
"""
@overload
def SetValid(self,Ls : OCP.TDF.TDF_LabelMap) -> None: ...
@staticmethod
def Set_s(Access : OCP.TDF.TDF_Label) -> TFunction_Logbook:
"""
Finds or Creates a TFunction_Logbook attribute at the root label accessed by <Access>. Returns the attribute.
"""
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 Transaction(self) -> int:
"""
Returns the transaction index in which the attribute has been created or modified.
Returns the transaction index in which the attribute has been created or modified.
"""
def UntilTransaction(self) -> int:
"""
Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
"""
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 TFunction_Scope(OCP.TDF.TDF_Attribute, OCP.Standard.Standard_Transient):
"""
Keeps a scope of functions.Keeps a scope of functions.Keeps a scope of functions.
"""
def AddAttribute(self,other : OCP.TDF.TDF_Attribute) -> None:
"""
Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.
"""
def AddFunction(self,L : OCP.TDF.TDF_Label) -> bool:
"""
Adds a function to the scope of functions.
"""
def AfterAddition(self) -> None:
"""
Something to do after adding an Attribute to a label.
"""
def AfterResume(self) -> None:
"""
Something to do after resuming an Attribute from a label.
"""
def AfterRetrieval(self,forceIt : bool=False) -> bool:
"""
Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def AfterUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def Backup(self) -> None:
"""
Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
"""
def BackupCopy(self) -> OCP.TDF.TDF_Attribute:
"""
Copies the attribute contents into a new other attribute. It is used by Backup().
"""
def BeforeCommitTransaction(self) -> None:
"""
A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
"""
def BeforeForget(self) -> None:
"""
Something to do before forgetting an Attribute to a label.
"""
def BeforeRemoval(self) -> None:
"""
Something to do before removing an Attribute from a label.
"""
def BeforeUndo(self,anAttDelta : OCP.TDF.TDF_AttributeDelta,forceIt : bool=False) -> bool:
"""
Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
"""
def ChangeFunctions(self) -> TFunction_DoubleMapOfIntegerLabel:
"""
Returns the scope of functions for modification. Warning: Don't use this method if You are not sure what You do!
"""
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 DeltaOnAddition(self) -> OCP.TDF.TDF_DeltaOnAddition:
"""
Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
"""
def DeltaOnForget(self) -> OCP.TDF.TDF_DeltaOnForget:
"""
Makes an AttributeDelta because <me> has been forgotten.
"""
@overload
def DeltaOnModification(self,anOldAttribute : OCP.TDF.TDF_Attribute) -> OCP.TDF.TDF_DeltaOnModification:
"""
Makes a DeltaOnModification between <me> and <anOldAttribute.
Applies a DeltaOnModification to <me>.
"""
@overload
def DeltaOnModification(self,aDelta : OCP.TDF.TDF_DeltaOnModification) -> None: ...
def DeltaOnRemoval(self) -> OCP.TDF.TDF_DeltaOnRemoval:
"""
Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
"""
def DeltaOnResume(self) -> OCP.TDF.TDF_DeltaOnResume:
"""
Makes an AttributeDelta because <me> has been resumed.
"""
def Dump(self,anOS : io.BytesIO) -> io.BytesIO:
"""
None
"""
def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None:
"""
Dumps the content of me into the stream
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def ExtendedDump(self,anOS : io.BytesIO,aFilter : OCP.TDF.TDF_IDFilter,aMap : OCP.TDF.TDF_AttributeIndexedMap) -> None:
"""
Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
"""
def FindAttribute(self,anID : OCP.Standard.Standard_GUID,anAttribute : OCP.TDF.TDF_Attribute) -> bool:
"""
Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
"""
def Forget(self,aTransaction : int) -> None:
"""
Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
"""
def ForgetAllAttributes(self,clearChildren : bool=True) -> None:
"""
Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call
"""
def ForgetAttribute(self,aguid : OCP.Standard.Standard_GUID) -> bool:
"""
Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
"""
def GetFreeID(self) -> int:
"""
None
"""
@overload
def GetFunction(self,ID : int) -> OCP.TDF.TDF_Label:
"""
Returns an ID of the function.
Returns the label of the function with this ID.
"""
@overload
def GetFunction(self,L : OCP.TDF.TDF_Label) -> int: ...
def GetFunctions(self) -> TFunction_DoubleMapOfIntegerLabel:
"""
Returns the scope of functions.
"""
@staticmethod
def GetID_s() -> OCP.Standard.Standard_GUID:
"""
Returns the GUID for Scope attribute. Instant methods =============== Constructor (empty).
"""
def GetLogbook(self) -> TFunction_Logbook:
"""
Returns the Logbook used in TFunction_Driver methods. Implementation of Attribute methods ===================================
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
@overload
def HasFunction(self,ID : int) -> bool:
"""
Returns true if the function exists with such an ID.
Returns true if the label contains a function of this scope.
"""
@overload
def HasFunction(self,L : OCP.TDF.TDF_Label) -> bool: ...
def ID(self) -> OCP.Standard.Standard_GUID:
"""
None
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsAttribute(self,anID : OCP.Standard.Standard_GUID) -> bool:
"""
Returns true if it exists an associated attribute of <me> with <anID> as ID.
"""
def IsBackuped(self) -> bool:
"""
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
"""
def IsForgotten(self) -> bool:
"""
Returns true if the attribute forgotten status is set.
Returns true if the attribute forgotten status is set.
"""
@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 IsNew(self) -> bool:
"""
Returns true if the attribute has no backup
Returns true if the attribute has no backup
"""
def IsValid(self) -> bool:
"""
Returns true if the attribute is valid; i.e. not a backuped or removed one.
Returns true if the attribute is valid; i.e. not a backuped or removed one.
"""
def Label(self) -> OCP.TDF.TDF_Label:
"""
Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning If the label is not included in a data framework, it is null. This function should not be redefined inline.
"""
def NewEmpty(self) -> OCP.TDF.TDF_Attribute:
"""
None
"""
def Paste(self,into : OCP.TDF.TDF_Attribute,RT : OCP.TDF.TDF_RelocationTable) -> None:
"""
None
"""
def References(self,aDataSet : OCP.TDF.TDF_DataSet) -> None:
"""
Adds the first level referenced attributes and labels to <aDataSet>.
"""
def RemoveAllFunctions(self) -> None:
"""
Removes all functions from the scope of functions.
"""
@overload
def RemoveFunction(self,ID : int) -> bool:
"""
Removes a function from the scope of functions.
Removes a function from the scope of functions.
"""
@overload
def RemoveFunction(self,L : OCP.TDF.TDF_Label) -> bool: ...
def Restore(self,with_ : OCP.TDF.TDF_Attribute) -> None:
"""
None
"""
def SetFreeID(self,ID : int) -> None:
"""
None
"""
@overload
def SetID(self) -> None:
"""
Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
Sets default ID defined in nested class (to be used for attributes having User ID feature).
"""
@overload
def SetID(self,arg1 : OCP.Standard.Standard_GUID) -> None: ...
@staticmethod
def Set_s(Access : OCP.TDF.TDF_Label) -> TFunction_Scope:
"""
Static methods ============== Finds or Creates a TFunction_Scope attribute at the root label accessed by <Access>. Returns the attribute.
"""
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 Transaction(self) -> int:
"""
Returns the transaction index in which the attribute has been created or modified.
Returns the transaction index in which the attribute has been created or modified.
"""
def UntilTransaction(self) -> int:
"""
Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
TFunction_ES_Executing: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_Executing: 2>
TFunction_ES_Failed: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_Failed: 4>
TFunction_ES_NotExecuted: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_NotExecuted: 1>
TFunction_ES_Succeeded: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_Succeeded: 3>
TFunction_ES_WrongDefinition: OCP.TFunction.TFunction_ExecutionStatus # value = <TFunction_ExecutionStatus.TFunction_ES_WrongDefinition: 0>
|