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
|
import OCP.CDF
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.PCDM
import OCP.Resource
import OCP.Message
import OCP.Standard
import OCP.CDM
import io
import OCP.TCollection
__all__ = [
"CDF_Application",
"CDF_Directory",
"CDF_DirectoryIterator",
"CDF_MetaDataDriver",
"CDF_FWOSDriver",
"CDF_MetaDataDriverFactory",
"CDF_Store",
"CDF_StoreList",
"CDF_StoreSetNameStatus",
"CDF_SubComponentStatus",
"CDF_TryStoreStatus",
"CDF_TypeOfActivation",
"CDF_SCS_Consistent",
"CDF_SCS_Modified",
"CDF_SCS_Stored",
"CDF_SCS_Unconsistent",
"CDF_SSNS_OK",
"CDF_SSNS_OpenDocument",
"CDF_SSNS_ReplacingAnExistentDocument",
"CDF_TOA_Modified",
"CDF_TOA_New",
"CDF_TOA_Unchanged",
"CDF_TS_NoCurrentDocument",
"CDF_TS_NoDriver",
"CDF_TS_NoSubComponentDriver",
"CDF_TS_OK"
]
class CDF_Application(OCP.CDM.CDM_Application, OCP.Standard.Standard_Transient):
def BeginOfUpdate(self,aDocument : OCP.CDM.CDM_Document) -> None:
"""
this method is called before the update of a document. By default, writes in MessageDriver().
"""
def CanClose(self,aDocument : OCP.CDM.CDM_Document) -> OCP.CDM.CDM_CanCloseStatus:
"""
None
"""
@overload
def CanRetrieve(self,theFolder : OCP.TCollection.TCollection_ExtendedString,theName : OCP.TCollection.TCollection_ExtendedString,theAppendMode : bool) -> OCP.PCDM.PCDM_ReaderStatus:
"""
None
None
"""
@overload
def CanRetrieve(self,theFolder : OCP.TCollection.TCollection_ExtendedString,theName : OCP.TCollection.TCollection_ExtendedString,theVersion : OCP.TCollection.TCollection_ExtendedString,theAppendMode : bool) -> OCP.PCDM.PCDM_ReaderStatus: ...
def Close(self,aDocument : OCP.CDM.CDM_Document) -> None:
"""
removes the document of the current session directory and closes the document;
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def DefaultFolder(self) -> str:
"""
None
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
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 EndOfUpdate(self,aDocument : OCP.CDM.CDM_Document,theStatus : bool,ErrorString : OCP.TCollection.TCollection_ExtendedString) -> None:
"""
this method is called affter the update of a document. By default, writes in MessageDriver().
"""
def Format(self,aFileName : OCP.TCollection.TCollection_ExtendedString,theFormat : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
try to retrieve a Format directly in the file or in application resource by using extension. returns True if found;
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def GetRetrieveStatus(self) -> OCP.PCDM.PCDM_ReaderStatus:
"""
Checks status after Retrieve
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def InitDocument(self,theDoc : OCP.CDM.CDM_Document) -> None:
"""
Initialize a document for the applicative session. This virtual function is called by NewDocument and should be redefined for each specific application.
"""
@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: ...
@staticmethod
def Load_s(aGUID : OCP.Standard.Standard_GUID) -> CDF_Application:
"""
plugs an application.
"""
def MessageDriver(self) -> OCP.Message.Message_Messenger:
"""
Returns default messenger;
"""
def MetaDataDriver(self) -> CDF_MetaDataDriver:
"""
returns MetaDatdDriver of this application
"""
def MetaDataLookUpTable(self) -> Any:
"""
Returns MetaData LookUpTable
"""
def Name(self) -> OCP.TCollection.TCollection_ExtendedString:
"""
Returns the application name.
"""
def NewDocument(self,theFormat : OCP.TCollection.TCollection_ExtendedString,theDoc : OCP.CDM.CDM_Document) -> Any:
"""
Constructs an new empty document. This document will have the specified format. If InitDocument() is redefined for a specific application, the new document is handled by the applicative session.
"""
def Open(self,aDocument : OCP.CDM.CDM_Document) -> None:
"""
puts the document in the current session directory and calls the virtual method Activate on it.
"""
def Read(self,theIStream : io.BytesIO,theDocument : OCP.CDM.CDM_Document,theFilter : OCP.PCDM.PCDM_ReaderFilter=None,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> Any:
"""
Reads theDocument from standard SEEKABLE stream theIStream, the stream should support SEEK functionality
"""
def ReaderFromFormat(self,aFormat : OCP.TCollection.TCollection_ExtendedString) -> OCP.PCDM.PCDM_Reader:
"""
Returns instance of read driver for specified format.
"""
def Resources(self) -> OCP.Resource.Resource_Manager:
"""
The manager returned by this virtual method will be used to search for Format.Retrieval resource items.
"""
@overload
def Retrieve(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString,UseStorageConfiguration : bool=True,theFilter : OCP.PCDM.PCDM_ReaderFilter=None,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> OCP.CDM.CDM_Document:
"""
This method retrieves a document from the database. If the Document references other documents which have been updated, the latest version of these documents will be used if {UseStorageConfiguration} is Standard_True. The content of {aFolder}, {aName} and {aVersion} depends on the Database Manager system. If the DBMS is only based on the OS, {aFolder} is a directory and {aName} is the name of a file. In this case the use of the syntax with {aVersion} has no sense. For example:
This method retrieves a document from the database. If the Document references other documents which have been updated, the latest version of these documents will be used if {UseStorageConfiguration} is Standard_True. -- If the DBMS is only based on the OS, this syntax should not be used.
"""
@overload
def Retrieve(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,UseStorageConfiguration : bool=True,theFilter : OCP.PCDM.PCDM_ReaderFilter=None,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> OCP.CDM.CDM_Document: ...
def SetDefaultFolder(self,aFolder : str) -> bool:
"""
None
"""
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 Version(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns the application version.
"""
def Write(self,aString : str) -> None:
"""
writes the string in the application MessagerDriver.
"""
def WriterFromFormat(self,aFormat : OCP.TCollection.TCollection_ExtendedString) -> OCP.PCDM.PCDM_StorageDriver:
"""
Returns instance of storage driver for specified format.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class CDF_Directory(OCP.Standard.Standard_Transient):
"""
A directory is a collection of documents. There is only one instance of a given document in a directory. put.A directory is a collection of documents. There is only one instance of a given document in a directory. put.A directory is a collection of documents. There is only one instance of a given document in a directory. put.
"""
def Add(self,aDocument : OCP.CDM.CDM_Document) -> None:
"""
adds a document into the directory.
"""
def Contains(self,aDocument : OCP.CDM.CDM_Document) -> bool:
"""
Returns true if the document aDocument is in the directory
"""
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 IsEmpty(self) -> bool:
"""
returns true if the directory is 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 Last(self) -> OCP.CDM.CDM_Document:
"""
returns the last document (if any) which has been added in the directory.
"""
def Length(self) -> int:
"""
returns the number of documents of the directory.
"""
def Remove(self,aDocument : OCP.CDM.CDM_Document) -> None:
"""
removes the document.
"""
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 CDF_DirectoryIterator():
"""
None
"""
def Document(self) -> OCP.CDM.CDM_Document:
"""
Returns item value of current entry
"""
def MoreDocument(self) -> bool:
"""
Returns True if there are more entries to return
"""
def NextDocument(self) -> None:
"""
Go to the next entry (if there is not, Value will raise an exception)
"""
def __init__(self,aDirectory : CDF_Directory) -> None: ...
pass
class CDF_MetaDataDriver(OCP.Standard.Standard_Transient):
"""
this class list the method that must be available for a specific DBMSthis class list the method that must be available for a specific DBMSthis class list the method that must be available for a specific DBMS
"""
def BuildFileName(self,aDocument : OCP.CDM.CDM_Document) -> OCP.TCollection.TCollection_ExtendedString:
"""
None
"""
def CreateDependsOn(self,aFirstData : OCP.CDM.CDM_MetaData,aSecondData : OCP.CDM.CDM_MetaData) -> None:
"""
Creates a "Depends On" relation between two Datas. By default does nothing
"""
def CreateMetaData(self,aDocument : OCP.CDM.CDM_Document,aFileName : OCP.TCollection.TCollection_ExtendedString) -> OCP.CDM.CDM_MetaData:
"""
should create meta-data corresponding to aData and maintaining a meta-link between these meta-data and aFileName CreateMetaData is called by CreateData If the metadata-driver has version capabilities, version must be set in the returned Data.
"""
def CreateReference(self,aFrom : OCP.CDM.CDM_MetaData,aTo : OCP.CDM.CDM_MetaData,aReferenceIdentifier : int,aToDocumentVersion : int) -> None:
"""
None
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def DefaultFolder(self) -> OCP.TCollection.TCollection_ExtendedString:
"""
None
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
@overload
def Find(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
should indicate whether meta-data exist in the DBMS corresponding to the Data. aVersion may be NULL;
calls Find with an empty version
"""
@overload
def Find(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString) -> bool: ...
def FindFolder(self,aFolder : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def HasReadPermission(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
None
"""
def HasVersion(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
by default return Standard_True.
"""
def HasVersionCapability(self) -> bool:
"""
returns true if the MetaDataDriver can manage different versions of a Data. By default, returns Standard_False.
"""
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 LastVersion(self,aMetaData : OCP.CDM.CDM_MetaData) -> OCP.CDM.CDM_MetaData:
"""
by default returns aMetaDATA should return the MetaData stored in the DBMS with the meta-data corresponding to the path. If the MetaDataDriver has version management capabilities the version has to be set in the returned MetaData. MetaData is called by GetMetaData If the version is not included in the path , MetaData should return the last version of the metadata is deferred;
"""
@overload
def MetaData(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString) -> OCP.CDM.CDM_MetaData:
"""
should return the MetaData stored in the DBMS with the meta-data corresponding to the Data. If the MetaDataDriver has version management capabilities the version has to be set in the returned MetaData. aVersion may be NULL MetaData is called by GetMetaData If the version is set to NULL, MetaData should return the last version of the metadata
calls MetaData with an empty version
"""
@overload
def MetaData(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString) -> OCP.CDM.CDM_MetaData: ...
def ReferenceIterator(self,theMessageDriver : OCP.Message.Message_Messenger) -> OCP.PCDM.PCDM_ReferenceIterator:
"""
None
"""
def SetName(self,aDocument : OCP.CDM.CDM_Document,aName : OCP.TCollection.TCollection_ExtendedString) -> OCP.TCollection.TCollection_ExtendedString:
"""
this method is useful if the name of an object -- depends on the metadatadriver. For example a Driver -- based on the operating system can choose to add the extension of file to create to the object.
"""
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 CDF_FWOSDriver(CDF_MetaDataDriver, OCP.Standard.Standard_Transient):
def BuildFileName(self,aDocument : OCP.CDM.CDM_Document) -> OCP.TCollection.TCollection_ExtendedString:
"""
None
"""
def CreateDependsOn(self,aFirstData : OCP.CDM.CDM_MetaData,aSecondData : OCP.CDM.CDM_MetaData) -> None:
"""
Creates a "Depends On" relation between two Datas. By default does nothing
"""
def CreateMetaData(self,aDocument : OCP.CDM.CDM_Document,aFileName : OCP.TCollection.TCollection_ExtendedString) -> OCP.CDM.CDM_MetaData:
"""
should create meta-data corresponding to aData and maintaining a meta-link between these meta-data and aFileName CreateMetaData is called by CreateData If the metadata-driver has version capabilities, version must be set in the returned Data.
"""
def CreateReference(self,aFrom : OCP.CDM.CDM_MetaData,aTo : OCP.CDM.CDM_MetaData,aReferenceIdentifier : int,aToDocumentVersion : int) -> None:
"""
None
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def DefaultFolder(self) -> OCP.TCollection.TCollection_ExtendedString:
"""
None
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Find(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
indicate whether a file exists corresponding to the folder and the name
"""
def FindFolder(self,aFolder : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def HasReadPermission(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
None
"""
def HasVersion(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
by default return Standard_True.
"""
def HasVersionCapability(self) -> bool:
"""
returns true if the MetaDataDriver can manage different versions of a Data. By default, returns Standard_False.
"""
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 LastVersion(self,aMetaData : OCP.CDM.CDM_MetaData) -> OCP.CDM.CDM_MetaData:
"""
by default returns aMetaDATA should return the MetaData stored in the DBMS with the meta-data corresponding to the path. If the MetaDataDriver has version management capabilities the version has to be set in the returned MetaData. MetaData is called by GetMetaData If the version is not included in the path , MetaData should return the last version of the metadata is deferred;
"""
@overload
def MetaData(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString) -> OCP.CDM.CDM_MetaData:
"""
should return the MetaData stored in the DBMS with the meta-data corresponding to the Data. If the MetaDataDriver has version management capabilities the version has to be set in the returned MetaData. aVersion may be NULL MetaData is called by GetMetaData If the version is set to NULL, MetaData should return the last version of the metadata
calls MetaData with an empty version
"""
@overload
def MetaData(self,aFolder : OCP.TCollection.TCollection_ExtendedString,aName : OCP.TCollection.TCollection_ExtendedString,aVersion : OCP.TCollection.TCollection_ExtendedString) -> OCP.CDM.CDM_MetaData: ...
def ReferenceIterator(self,theMessageDriver : OCP.Message.Message_Messenger) -> OCP.PCDM.PCDM_ReferenceIterator:
"""
None
"""
def SetName(self,aDocument : OCP.CDM.CDM_Document,aName : OCP.TCollection.TCollection_ExtendedString) -> OCP.TCollection.TCollection_ExtendedString:
"""
None
"""
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,theLookUpTable : Any) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class CDF_MetaDataDriverFactory(OCP.Standard.Standard_Transient):
def Build(self) -> CDF_MetaDataDriver:
"""
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 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 CDF_Store():
"""
None
"""
def AssociatedStatusText(self) -> str:
"""
None
"""
def Comment(self) -> OCP.TCollection.TCollection_HExtendedString:
"""
None
"""
def CurrentIsConsistent(self) -> bool:
"""
None
"""
def Description(self) -> OCP.TCollection.TCollection_HExtendedString:
"""
returns the description of the format of the main object.
"""
def Folder(self) -> OCP.TCollection.TCollection_HExtendedString:
"""
returns the folder in which the current document will be stored.
"""
def HasAPreviousVersion(self) -> bool:
"""
None
"""
def IsConsistent(self) -> bool:
"""
None
"""
def IsMainDocument(self) -> bool:
"""
returns true if the currentdocument is the main one, ie the document of the current selection.
"""
def IsModified(self) -> bool:
"""
None
"""
def IsStored(self) -> bool:
"""
returns true if the current document is already stored
"""
def MetaDataPath(self) -> OCP.TCollection.TCollection_HExtendedString:
"""
returns the path of the previous store is the object is already stored, otherwise an empty string;
"""
def Name(self) -> OCP.TCollection.TCollection_HExtendedString:
"""
returns the name under which the current document will be stored
"""
def Path(self) -> str:
"""
returns the complete path of the created meta-data.
"""
def PreviousVersion(self) -> OCP.TCollection.TCollection_HExtendedString:
"""
None
"""
def Realize(self,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> None:
"""
None
"""
def RecheckName(self) -> CDF_StoreSetNameStatus:
"""
defines the name under which the document should be stored. uses for example after modification of the folder.
"""
def SetComment(self,aComment : str) -> None:
"""
None
"""
def SetCurrent(self,aPresentation : str) -> None:
"""
None
"""
@overload
def SetFolder(self,aFolder : OCP.TCollection.TCollection_ExtendedString) -> bool:
"""
defines the folder in which the document should be stored. returns Standard_True if the Folder exists, Standard_False otherwise.
defines the folder in which the document should be stored. returns Standard_True if the Folder exists, Standard_False otherwise.
"""
@overload
def SetFolder(self,aFolder : str) -> bool: ...
def SetMain(self) -> None:
"""
the two following methods can be used just after Realize or Import -- method to know if thes methods worked correctly, and if not why.
"""
@overload
def SetName(self,aName : str) -> CDF_StoreSetNameStatus:
"""
defines the name under which the document should be stored.
defines the name under which the document should be stored.
"""
@overload
def SetName(self,aName : OCP.TCollection.TCollection_ExtendedString) -> CDF_StoreSetNameStatus: ...
def SetPreviousVersion(self,aPreviousVersion : str) -> bool:
"""
None
"""
def StoreStatus(self) -> OCP.PCDM.PCDM_StoreStatus:
"""
None
"""
def __init__(self,aDocument : OCP.CDM.CDM_Document) -> None: ...
pass
class CDF_StoreList(OCP.Standard.Standard_Transient):
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) -> None:
"""
None
"""
def IsConsistent(self) -> bool:
"""
None
"""
@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 More(self) -> bool:
"""
None
"""
def Next(self) -> None:
"""
None
"""
def Store(self,aMetaData : OCP.CDM.CDM_MetaData,aStatusAssociatedText : OCP.TCollection.TCollection_ExtendedString,theRange : OCP.Message.Message_ProgressRange=OCP.Message.Message_ProgressRange) -> OCP.PCDM.PCDM_StoreStatus:
"""
stores each object of the storelist in the reverse order of which they had been added.
"""
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) -> OCP.CDM.CDM_Document:
"""
None
"""
def __init__(self,aDocument : OCP.CDM.CDM_Document) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class CDF_StoreSetNameStatus():
"""
None
Members:
CDF_SSNS_OK
CDF_SSNS_ReplacingAnExistentDocument
CDF_SSNS_OpenDocument
"""
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
"""
CDF_SSNS_OK: OCP.CDF.CDF_StoreSetNameStatus # value = <CDF_StoreSetNameStatus.CDF_SSNS_OK: 0>
CDF_SSNS_OpenDocument: OCP.CDF.CDF_StoreSetNameStatus # value = <CDF_StoreSetNameStatus.CDF_SSNS_OpenDocument: 2>
CDF_SSNS_ReplacingAnExistentDocument: OCP.CDF.CDF_StoreSetNameStatus # value = <CDF_StoreSetNameStatus.CDF_SSNS_ReplacingAnExistentDocument: 1>
__entries: dict # value = {'CDF_SSNS_OK': (<CDF_StoreSetNameStatus.CDF_SSNS_OK: 0>, None), 'CDF_SSNS_ReplacingAnExistentDocument': (<CDF_StoreSetNameStatus.CDF_SSNS_ReplacingAnExistentDocument: 1>, None), 'CDF_SSNS_OpenDocument': (<CDF_StoreSetNameStatus.CDF_SSNS_OpenDocument: 2>, None)}
__members__: dict # value = {'CDF_SSNS_OK': <CDF_StoreSetNameStatus.CDF_SSNS_OK: 0>, 'CDF_SSNS_ReplacingAnExistentDocument': <CDF_StoreSetNameStatus.CDF_SSNS_ReplacingAnExistentDocument: 1>, 'CDF_SSNS_OpenDocument': <CDF_StoreSetNameStatus.CDF_SSNS_OpenDocument: 2>}
pass
class CDF_SubComponentStatus():
"""
None
Members:
CDF_SCS_Consistent
CDF_SCS_Unconsistent
CDF_SCS_Stored
CDF_SCS_Modified
"""
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
"""
CDF_SCS_Consistent: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Consistent: 0>
CDF_SCS_Modified: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Modified: 3>
CDF_SCS_Stored: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Stored: 2>
CDF_SCS_Unconsistent: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Unconsistent: 1>
__entries: dict # value = {'CDF_SCS_Consistent': (<CDF_SubComponentStatus.CDF_SCS_Consistent: 0>, None), 'CDF_SCS_Unconsistent': (<CDF_SubComponentStatus.CDF_SCS_Unconsistent: 1>, None), 'CDF_SCS_Stored': (<CDF_SubComponentStatus.CDF_SCS_Stored: 2>, None), 'CDF_SCS_Modified': (<CDF_SubComponentStatus.CDF_SCS_Modified: 3>, None)}
__members__: dict # value = {'CDF_SCS_Consistent': <CDF_SubComponentStatus.CDF_SCS_Consistent: 0>, 'CDF_SCS_Unconsistent': <CDF_SubComponentStatus.CDF_SCS_Unconsistent: 1>, 'CDF_SCS_Stored': <CDF_SubComponentStatus.CDF_SCS_Stored: 2>, 'CDF_SCS_Modified': <CDF_SubComponentStatus.CDF_SCS_Modified: 3>}
pass
class CDF_TryStoreStatus():
"""
None
Members:
CDF_TS_OK
CDF_TS_NoCurrentDocument
CDF_TS_NoDriver
CDF_TS_NoSubComponentDriver
"""
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
"""
CDF_TS_NoCurrentDocument: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_NoCurrentDocument: 1>
CDF_TS_NoDriver: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_NoDriver: 2>
CDF_TS_NoSubComponentDriver: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_NoSubComponentDriver: 3>
CDF_TS_OK: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_OK: 0>
__entries: dict # value = {'CDF_TS_OK': (<CDF_TryStoreStatus.CDF_TS_OK: 0>, None), 'CDF_TS_NoCurrentDocument': (<CDF_TryStoreStatus.CDF_TS_NoCurrentDocument: 1>, None), 'CDF_TS_NoDriver': (<CDF_TryStoreStatus.CDF_TS_NoDriver: 2>, None), 'CDF_TS_NoSubComponentDriver': (<CDF_TryStoreStatus.CDF_TS_NoSubComponentDriver: 3>, None)}
__members__: dict # value = {'CDF_TS_OK': <CDF_TryStoreStatus.CDF_TS_OK: 0>, 'CDF_TS_NoCurrentDocument': <CDF_TryStoreStatus.CDF_TS_NoCurrentDocument: 1>, 'CDF_TS_NoDriver': <CDF_TryStoreStatus.CDF_TS_NoDriver: 2>, 'CDF_TS_NoSubComponentDriver': <CDF_TryStoreStatus.CDF_TS_NoSubComponentDriver: 3>}
pass
class CDF_TypeOfActivation():
"""
None
Members:
CDF_TOA_New
CDF_TOA_Modified
CDF_TOA_Unchanged
"""
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
"""
CDF_TOA_Modified: OCP.CDF.CDF_TypeOfActivation # value = <CDF_TypeOfActivation.CDF_TOA_Modified: 1>
CDF_TOA_New: OCP.CDF.CDF_TypeOfActivation # value = <CDF_TypeOfActivation.CDF_TOA_New: 0>
CDF_TOA_Unchanged: OCP.CDF.CDF_TypeOfActivation # value = <CDF_TypeOfActivation.CDF_TOA_Unchanged: 2>
__entries: dict # value = {'CDF_TOA_New': (<CDF_TypeOfActivation.CDF_TOA_New: 0>, None), 'CDF_TOA_Modified': (<CDF_TypeOfActivation.CDF_TOA_Modified: 1>, None), 'CDF_TOA_Unchanged': (<CDF_TypeOfActivation.CDF_TOA_Unchanged: 2>, None)}
__members__: dict # value = {'CDF_TOA_New': <CDF_TypeOfActivation.CDF_TOA_New: 0>, 'CDF_TOA_Modified': <CDF_TypeOfActivation.CDF_TOA_Modified: 1>, 'CDF_TOA_Unchanged': <CDF_TypeOfActivation.CDF_TOA_Unchanged: 2>}
pass
CDF_SCS_Consistent: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Consistent: 0>
CDF_SCS_Modified: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Modified: 3>
CDF_SCS_Stored: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Stored: 2>
CDF_SCS_Unconsistent: OCP.CDF.CDF_SubComponentStatus # value = <CDF_SubComponentStatus.CDF_SCS_Unconsistent: 1>
CDF_SSNS_OK: OCP.CDF.CDF_StoreSetNameStatus # value = <CDF_StoreSetNameStatus.CDF_SSNS_OK: 0>
CDF_SSNS_OpenDocument: OCP.CDF.CDF_StoreSetNameStatus # value = <CDF_StoreSetNameStatus.CDF_SSNS_OpenDocument: 2>
CDF_SSNS_ReplacingAnExistentDocument: OCP.CDF.CDF_StoreSetNameStatus # value = <CDF_StoreSetNameStatus.CDF_SSNS_ReplacingAnExistentDocument: 1>
CDF_TOA_Modified: OCP.CDF.CDF_TypeOfActivation # value = <CDF_TypeOfActivation.CDF_TOA_Modified: 1>
CDF_TOA_New: OCP.CDF.CDF_TypeOfActivation # value = <CDF_TypeOfActivation.CDF_TOA_New: 0>
CDF_TOA_Unchanged: OCP.CDF.CDF_TypeOfActivation # value = <CDF_TypeOfActivation.CDF_TOA_Unchanged: 2>
CDF_TS_NoCurrentDocument: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_NoCurrentDocument: 1>
CDF_TS_NoDriver: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_NoDriver: 2>
CDF_TS_NoSubComponentDriver: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_NoSubComponentDriver: 3>
CDF_TS_OK: OCP.CDF.CDF_TryStoreStatus # value = <CDF_TryStoreStatus.CDF_TS_OK: 0>
|