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
|
import OCP.StdStorage
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.StdObjMgt
import OCP.NCollection
import OCP.TColStd
import OCP.Standard
import OCP.Storage
import OCP.TCollection
__all__ = [
"StdStorage",
"StdStorage_BucketIterator",
"StdStorage_Data",
"StdStorage_SequenceOfRoots",
"StdStorage_HeaderData",
"StdStorage_Root",
"StdStorage_RootData",
"StdStorage_HSequenceOfRoots",
"StdStorage_TypeData"
]
class StdStorage():
"""
StdStorage package is used to write and read persistent objects. These objects are read and written by a retrieval or storage algorithm (compatible with legacy Storage_Schema) in a container (disk, memory, network ...). Drivers (FSD_File objects) assign a physical container for data to be stored or retrieved. The standard procedure for an application in reading a container is to call one of the Read functions providing either a file path or a driver opened for reading. Thes function update the instance of the StdStorage_Data class which contains the data being read. The standard procedure for an application in writing a container is the following: - open the driver in writing mode, - create an instance of the StdStorage_Data class, then add the persistent data to write with the function AddRoot, - call the function Write from the storage, setting the driver and the Storage_Data instance as parameters, - close the driver.
"""
@staticmethod
@overload
def Read_s(theDriver : OCP.Storage.Storage_BaseDriver,theData : StdStorage_Data) -> OCP.Storage.Storage_Error:
"""
Returns the data read from a file located at theFileName. The storage format is compartible with legacy persistent one. These data are aggregated in a StdStorage_Data object which may be browsed in order to extract the root objects from the container. Note: - theData object will be created if it is null or cleared otherwise.
Returns the data read from the container defined by theDriver. The storage format is compartible with legacy persistent one. These data are aggregated in a StdStorage_Data object which may be browsed in order to extract the root objects from the container. Note: - theData object will be created if it is null or cleared otherwise.
"""
@staticmethod
@overload
def Read_s(theFileName : OCP.TCollection.TCollection_AsciiString,theData : StdStorage_Data) -> OCP.Storage.Storage_Error: ...
@staticmethod
def Version_s() -> OCP.TCollection.TCollection_AsciiString:
"""
Returns the version of Storage's read/write routines
"""
@staticmethod
def Write_s(theDriver : OCP.Storage.Storage_BaseDriver,theData : StdStorage_Data) -> OCP.Storage.Storage_Error:
"""
Writes the data aggregated in theData object into the container defined by theDriver. The storage format is compartible with legacy persistent one. Note: - theData may aggregate several root objects to be stored together. - createion date specified in the srorage header will be overwritten.
"""
def __init__(self) -> None: ...
pass
class StdStorage_BucketIterator():
"""
None
"""
def Init(self,arg1 : StdStorage_BucketOfPersistent) -> None:
"""
None
"""
def More(self) -> bool:
"""
None
"""
def Next(self) -> None:
"""
None
"""
def Reset(self) -> None:
"""
None
"""
def Value(self) -> OCP.StdObjMgt.StdObjMgt_Persistent:
"""
None
"""
def __init__(self,arg1 : StdStorage_BucketOfPersistent) -> None: ...
pass
class StdStorage_Data(OCP.Standard.Standard_Transient):
"""
A picture memorizing the stored in a container (for example, in a file). A StdStorage_Data object represents either: - persistent data to be written into a container, or - persistent data which are read from a container. A StdStorage_Data object is used in both the storage and retrieval operations: - Storage mechanism: create an empty StdStorage_Data object, then add successively persistent objects (roots) to be stored using the StdStorage_RootData's function AddRoot. When the set of data is complete, write it to a container using the function Write in your StdStorage algorithm. - Retrieval mechanism: a StdStorage_Data object is returned by the Read function from your StdStorage algorithm. Use the StdStorage_RootData's functions NumberOfRoots and Roots to find the roots which were stored in the read container. The roots of a StdStorage_Data object may share references on objects. The shared internal references of a StdStorage_Data object are maintained by the storage/retrieval mechanism. Note: References shared by objects which are contained in two distinct StdStorage_Data objects are not maintained by the storage/retrieval mechanism: external references are not supported by Storage_Schema algorithm
"""
def Clear(self) -> None:
"""
Makes the container empty
"""
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:
"""
Returns a type descriptor about this object.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def HeaderData(self) -> StdStorage_HeaderData:
"""
Returns the header data section
"""
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 RootData(self) -> StdStorage_RootData:
"""
Returns the root data section
"""
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 TypeData(self) -> StdStorage_TypeData:
"""
Returns the type data section
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
Returns type descriptor of Standard_Transient class
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class StdStorage_SequenceOfRoots(OCP.NCollection.NCollection_BaseSequence):
"""
Purpose: Definition of a sequence of elements indexed by an Integer in range of 1..n
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
@overload
def Append(self,theSeq : StdStorage_SequenceOfRoots) -> None:
"""
Append one item
Append another sequence (making it empty)
"""
@overload
def Append(self,theItem : StdStorage_Root) -> None: ...
def Assign(self,theOther : StdStorage_SequenceOfRoots) -> StdStorage_SequenceOfRoots:
"""
Replace this sequence by the items of theOther. This method does not change the internal allocator.
"""
def ChangeFirst(self) -> StdStorage_Root:
"""
First item access
"""
def ChangeLast(self) -> StdStorage_Root:
"""
Last item access
"""
def ChangeValue(self,theIndex : int) -> StdStorage_Root:
"""
Variable item access by theIndex
"""
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None:
"""
Clear the items out, take a new allocator if non null
"""
def Exchange(self,I : int,J : int) -> None:
"""
Exchange two members
"""
def First(self) -> StdStorage_Root:
"""
First item access
"""
@overload
def InsertAfter(self,theIndex : int,theSeq : StdStorage_SequenceOfRoots) -> None:
"""
InsertAfter theIndex another sequence (making it empty)
InsertAfter theIndex theItem
"""
@overload
def InsertAfter(self,theIndex : int,theItem : StdStorage_Root) -> None: ...
@overload
def InsertBefore(self,theIndex : int,theItem : StdStorage_Root) -> None:
"""
InsertBefore theIndex theItem
InsertBefore theIndex another sequence (making it empty)
"""
@overload
def InsertBefore(self,theIndex : int,theSeq : StdStorage_SequenceOfRoots) -> None: ...
def IsEmpty(self) -> bool:
"""
Empty query
"""
def Last(self) -> StdStorage_Root:
"""
Last item access
"""
def Length(self) -> int:
"""
Number of items
"""
def Lower(self) -> int:
"""
Method for consistency with other collections.
"""
@overload
def Prepend(self,theItem : StdStorage_Root) -> None:
"""
Prepend one item
Prepend another sequence (making it empty)
"""
@overload
def Prepend(self,theSeq : StdStorage_SequenceOfRoots) -> None: ...
@overload
def Remove(self,theFromIndex : int,theToIndex : int) -> None:
"""
Remove one item
Remove range of items
"""
@overload
def Remove(self,theIndex : int) -> None: ...
def Reverse(self) -> None:
"""
Reverse sequence
"""
def SetValue(self,theIndex : int,theItem : StdStorage_Root) -> None:
"""
Set item value by theIndex
"""
def Size(self) -> int:
"""
Number of items
"""
def Split(self,theIndex : int,theSeq : StdStorage_SequenceOfRoots) -> None:
"""
Split in two sequences
"""
def Upper(self) -> int:
"""
Method for consistency with other collections.
"""
def Value(self,theIndex : int) -> StdStorage_Root:
"""
Constant item access by theIndex
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> StdStorage_Root:
"""
Constant operator()
Variable operator()
"""
@overload
def __init__(self) -> None: ...
@overload
def __init__(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator) -> None: ...
@overload
def __init__(self,theOther : StdStorage_SequenceOfRoots) -> None: ...
def __iter__(self) -> Iterator[StdStorage_Root]: ...
def __len__(self) -> int: ...
@staticmethod
def delNode_s(theNode : NCollection_SeqNode,theAl : OCP.NCollection.NCollection_BaseAllocator) -> None:
"""
Static deleter to be passed to BaseSequence
"""
pass
class StdStorage_HeaderData(OCP.Standard.Standard_Transient):
"""
Storage header data section that contains some auxiliary information (application name, schema version, creation date, comments and so on...)Storage header data section that contains some auxiliary information (application name, schema version, creation date, comments and so on...)Storage header data section that contains some auxiliary information (application name, schema version, creation date, comments and so on...)
"""
def AddToComments(self,aComment : OCP.TCollection.TCollection_ExtendedString) -> None:
"""
Add <theUserInfo> to the user information
"""
def AddToUserInfo(self,theUserInfo : OCP.TCollection.TCollection_AsciiString) -> None:
"""
Add <theUserInfo> to the user information
"""
def ApplicationName(self) -> OCP.TCollection.TCollection_ExtendedString:
"""
Get the name of the application
"""
def ApplicationVersion(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Get the version of the application
"""
def ClearErrorStatus(self) -> None:
"""
Clears error status
"""
def Comments(self) -> OCP.TColStd.TColStd_SequenceOfExtendedString:
"""
Return the user information
"""
def CreationDate(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Return the creation date
"""
def DataType(self) -> OCP.TCollection.TCollection_ExtendedString:
"""
Returns data type
"""
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 ErrorStatus(self) -> OCP.Storage.Storage_Error:
"""
Returns a status of the latest call to Read / Write functions
"""
def ErrorStatusExtension(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns an error message if any of the latest call to Read / Write functions
"""
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 NumberOfObjects(self) -> int:
"""
Returns the number of persistent objects
"""
def Read(self,theDriver : OCP.Storage.Storage_BaseDriver) -> bool:
"""
Reads the header data section from the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
"""
def SchemaVersion(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Get the version of the schema
"""
def SetApplicationName(self,aName : OCP.TCollection.TCollection_ExtendedString) -> None:
"""
Set the name of the application
"""
def SetApplicationVersion(self,aVersion : OCP.TCollection.TCollection_AsciiString) -> None:
"""
Set the version of the application
"""
def SetCreationDate(self,aDate : OCP.TCollection.TCollection_AsciiString) -> None:
"""
None
"""
def SetDataType(self,aType : OCP.TCollection.TCollection_ExtendedString) -> None:
"""
Set the data type
"""
def SetNumberOfObjects(self,anObjectNumber : int) -> None:
"""
None
"""
def SetSchemaName(self,aName : OCP.TCollection.TCollection_AsciiString) -> None:
"""
None
"""
def SetSchemaVersion(self,aVersion : OCP.TCollection.TCollection_AsciiString) -> None:
"""
None
"""
def SetStorageVersion(self,aVersion : OCP.TCollection.TCollection_AsciiString) -> None:
"""
None
"""
def StorageVersion(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Return the Storage package version
"""
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 UserInfo(self) -> OCP.TColStd.TColStd_SequenceOfAsciiString:
"""
Return the user information
"""
def Write(self,theDriver : OCP.Storage.Storage_BaseDriver) -> bool:
"""
Writes the header data section to the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class StdStorage_Root(OCP.Standard.Standard_Transient):
"""
Describes a named persistent rootDescribes a named persistent root
"""
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 Name(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns a name of the root
"""
def Object(self) -> OCP.StdObjMgt.StdObjMgt_Persistent:
"""
Returns a root's persistent object
"""
def Reference(self) -> int:
"""
Returns root's position in the root data section
"""
def SetName(self,theName : OCP.TCollection.TCollection_AsciiString) -> None:
"""
Sets a name to the root object
"""
def SetObject(self,anObject : OCP.StdObjMgt.StdObjMgt_Persistent) -> None:
"""
Sets a root's persistent object
"""
def SetType(self,aType : OCP.TCollection.TCollection_AsciiString) -> None:
"""
Sets a root's persistent type
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Type(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns a root's persistent type
"""
@overload
def __init__(self,theName : OCP.TCollection.TCollection_AsciiString,theObject : OCP.StdObjMgt.StdObjMgt_Persistent) -> None: ...
@overload
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class StdStorage_RootData(OCP.Standard.Standard_Transient):
"""
Storage root data section contains root persistent objectsStorage root data section contains root persistent objectsStorage root data section contains root persistent objects
"""
def AddRoot(self,aRoot : StdStorage_Root) -> None:
"""
Add a root to <me>. If a root with same name is present, it will be replaced by <aRoot>.
"""
def Clear(self) -> None:
"""
Removes all persistent root objects
"""
def ClearErrorStatus(self) -> None:
"""
Clears error status
"""
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 ErrorStatus(self) -> OCP.Storage.Storage_Error:
"""
Returns a status of the latest call to Read / Write functions
"""
def ErrorStatusExtension(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns an error message if any of the latest call to Read / Write functions
"""
def Find(self,aName : OCP.TCollection.TCollection_AsciiString) -> StdStorage_Root:
"""
Finds a root with name <aName>.
"""
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 IsRoot(self,aName : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Returns Standard_True if <me> contains a root named <aName>
"""
def NumberOfRoots(self) -> int:
"""
Returns the number of roots.
"""
def Read(self,theDriver : OCP.Storage.Storage_BaseDriver) -> bool:
"""
Reads the root data section from the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
"""
def RemoveRoot(self,aName : OCP.TCollection.TCollection_AsciiString) -> None:
"""
Removes the root named <aName>.
"""
def Roots(self) -> StdStorage_HSequenceOfRoots:
"""
Returns a sequence of all roots
"""
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 Write(self,theDriver : OCP.Storage.Storage_BaseDriver) -> bool:
"""
Writes the root data section to the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class StdStorage_HSequenceOfRoots(StdStorage_SequenceOfRoots, OCP.NCollection.NCollection_BaseSequence, OCP.Standard.Standard_Transient):
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns attached allocator
"""
@overload
def Append(self,theSequence : StdStorage_SequenceOfRoots) -> None:
"""
None
None
"""
@overload
def Append(self,theItem : StdStorage_Root) -> None: ...
def Assign(self,theOther : StdStorage_SequenceOfRoots) -> StdStorage_SequenceOfRoots:
"""
Replace this sequence by the items of theOther. This method does not change the internal allocator.
"""
def ChangeFirst(self) -> StdStorage_Root:
"""
First item access
"""
def ChangeLast(self) -> StdStorage_Root:
"""
Last item access
"""
def ChangeSequence(self) -> StdStorage_SequenceOfRoots:
"""
None
"""
def ChangeValue(self,theIndex : int) -> StdStorage_Root:
"""
Variable item access by theIndex
"""
def Clear(self,theAllocator : OCP.NCollection.NCollection_BaseAllocator=None) -> None:
"""
Clear the items out, take a new allocator if non null
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Exchange(self,I : int,J : int) -> None:
"""
Exchange two members
"""
def First(self) -> StdStorage_Root:
"""
First item access
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def InsertAfter(self,theIndex : int,theSeq : StdStorage_SequenceOfRoots) -> None:
"""
InsertAfter theIndex another sequence (making it empty)
InsertAfter theIndex theItem
"""
@overload
def InsertAfter(self,theIndex : int,theItem : StdStorage_Root) -> None: ...
@overload
def InsertBefore(self,theIndex : int,theItem : StdStorage_Root) -> None:
"""
InsertBefore theIndex theItem
InsertBefore theIndex another sequence (making it empty)
"""
@overload
def InsertBefore(self,theIndex : int,theSeq : StdStorage_SequenceOfRoots) -> None: ...
def IsEmpty(self) -> bool:
"""
Empty query
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Last(self) -> StdStorage_Root:
"""
Last item access
"""
def Length(self) -> int:
"""
Number of items
"""
def Lower(self) -> int:
"""
Method for consistency with other collections.
"""
@overload
def Prepend(self,theItem : StdStorage_Root) -> None:
"""
Prepend one item
Prepend another sequence (making it empty)
"""
@overload
def Prepend(self,theSeq : StdStorage_SequenceOfRoots) -> None: ...
@overload
def Remove(self,theFromIndex : int,theToIndex : int) -> None:
"""
Remove one item
Remove range of items
"""
@overload
def Remove(self,theIndex : int) -> None: ...
def Reverse(self) -> None:
"""
Reverse sequence
"""
def Sequence(self) -> StdStorage_SequenceOfRoots:
"""
None
"""
def SetValue(self,theIndex : int,theItem : StdStorage_Root) -> None:
"""
Set item value by theIndex
"""
def Size(self) -> int:
"""
Number of items
"""
def Split(self,theIndex : int,theSeq : StdStorage_SequenceOfRoots) -> None:
"""
Split in two sequences
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Upper(self) -> int:
"""
Method for consistency with other collections.
"""
def Value(self,theIndex : int) -> StdStorage_Root:
"""
Constant item access by theIndex
"""
def __bool__(self) -> bool: ...
def __call__(self,theIndex : int) -> StdStorage_Root:
"""
Constant operator()
Variable operator()
"""
@overload
def __init__(self,theOther : StdStorage_SequenceOfRoots) -> None: ...
@overload
def __init__(self) -> None: ...
def __iter__(self) -> Iterator[StdStorage_Root]: ...
def __len__(self) -> int: ...
@staticmethod
def delNode_s(theNode : NCollection_SeqNode,theAl : OCP.NCollection.NCollection_BaseAllocator) -> None:
"""
Static deleter to be passed to BaseSequence
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class StdStorage_TypeData(OCP.Standard.Standard_Transient):
"""
Storage type data section keeps association between persistent textual types and their numbersStorage type data section keeps association between persistent textual types and their numbersStorage type data section keeps association between persistent textual types and their numbers
"""
@overload
def AddType(self,aTypeName : OCP.TCollection.TCollection_AsciiString,aTypeNum : int) -> None:
"""
Add a type to the list in case of reading data
Add a type of the persistent object in case of writing data
"""
@overload
def AddType(self,aPObj : OCP.StdObjMgt.StdObjMgt_Persistent) -> int: ...
def Clear(self) -> None:
"""
Unregisters all types
"""
def ClearErrorStatus(self) -> None:
"""
Clears error status
"""
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 ErrorStatus(self) -> OCP.Storage.Storage_Error:
"""
Returns a status of the latest call to Read / Write functions
"""
def ErrorStatusExtension(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Returns an error message if any of the latest call to Read / Write functions
"""
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 IsType(self,aName : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Checks if <aName> is a registered type
"""
def NumberOfTypes(self) -> int:
"""
Returns the number of registered types
"""
def Read(self,theDriver : OCP.Storage.Storage_BaseDriver) -> bool:
"""
Reads the type data section from the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@overload
def Type(self,aTypeName : OCP.TCollection.TCollection_AsciiString) -> int:
"""
Returns the name of the type with number <aTypeNum>
Returns the name of the type with number <aTypeNum>
"""
@overload
def Type(self,aTypeNum : int) -> OCP.TCollection.TCollection_AsciiString: ...
def Types(self) -> OCP.TColStd.TColStd_HSequenceOfAsciiString:
"""
Returns a sequence of all registered types
"""
def Write(self,theDriver : OCP.Storage.Storage_BaseDriver) -> bool:
"""
Writes the type data section to the container defined by theDriver. Returns Standard_True in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
"""
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
|