import OCP.IGESData from typing import * from typing import Iterable as iterable from typing import Iterator as iterator from numpy import float64 _Shape = Tuple[int, ...] import OCP.Message import OCP.Interface import OCP.gp import OCP.TColStd import OCP.Standard import io import OCP.ShapeBuild import OCP.TCollection __all__ = [ "IGESData", "IGESData_Array1OfDirPart", "IGESData_Array1OfIGESEntity", "IGESData_BasicEditor", "IGESData_IGESEntity", "IGESData_DefList", "IGESData_DefSwitch", "IGESData_DefType", "IGESData_GeneralModule", "IGESData_SpecificModule", "IGESData_DirChecker", "IGESData_DirPart", "IGESData_Protocol", "IGESData_FileRecognizer", "IGESData_UndefinedEntity", "IGESData_DefaultGeneral", "IGESData_GlobalNodeOfSpecificLib", "IGESData_GlobalNodeOfWriterLib", "IGESData_GlobalSection", "IGESData_HArray1OfIGESEntity", "IGESData_IGESDumper", "IGESData_ColorEntity", "IGESData_IGESModel", "IGESData_IGESReaderData", "IGESData_IGESReaderTool", "IGESData_IGESType", "IGESData_IGESWriter", "IGESData_LabelDisplayEntity", "IGESData_LevelListEntity", "IGESData_LineFontEntity", "IGESData_NameEntity", "IGESData_NodeOfSpecificLib", "IGESData_NodeOfWriterLib", "IGESData_ParamCursor", "IGESData_ParamReader", "IGESData_FileProtocol", "IGESData_ReadStage", "IGESData_ReadWriteModule", "IGESData_SingleParentEntity", "IGESData_SpecificLib", "IGESData_DefaultSpecific", "IGESData_Status", "IGESData_ToolLocation", "IGESData_TransfEntity", "IGESData_FreeFormatEntity", "IGESData_ViewKindEntity", "IGESData_WriterLib", "IGESData_DefAny", "IGESData_DefNone", "IGESData_DefOne", "IGESData_DefReference", "IGESData_DefSeveral", "IGESData_DefValue", "IGESData_DefVoid", "IGESData_EntityError", "IGESData_EntityOK", "IGESData_ErrorOne", "IGESData_ErrorRef", "IGESData_ErrorSeveral", "IGESData_ErrorVal", "IGESData_ReadAssocs", "IGESData_ReadDir", "IGESData_ReadEnd", "IGESData_ReadOwn", "IGESData_ReadProps", "IGESData_ReferenceError", "IGESData_TypeError" ] class IGESData(): """ basic description of an IGES Interface """ @staticmethod def Init_s() -> None: """ Prepares General dynamic data used for IGESData specifically : Protocol and Modules, which treat UndefinedEntity """ @staticmethod def Protocol_s() -> IGESData_Protocol: """ Returns a Protocol from IGESData (avoids to create it) """ def __init__(self) -> None: ... pass class IGESData_Array1OfDirPart(): """ 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 : IGESData_Array1OfDirPart) -> IGESData_Array1OfDirPart: """ 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 : IGESData_DirPart) -> 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 : IGESData_Array1OfDirPart) -> IGESData_Array1OfDirPart: """ 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 : IGESData_DirPart) -> 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) -> IGESData_DirPart: ... @overload def __init__(self,theLower : int,theUpper : int) -> None: ... @overload def __init__(self,theAlloc : Any,theLower : int,theUpper : int) -> None: ... @overload def __init__(self,theOther : IGESData_Array1OfDirPart) -> None: ... @overload def __init__(self) -> None: ... def __iter__(self) -> Iterator[IGESData_DirPart]: ... def __len__(self) -> int: ... pass class IGESData_Array1OfIGESEntity(): """ 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 : IGESData_Array1OfIGESEntity) -> IGESData_Array1OfIGESEntity: """ 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 : IGESData_IGESEntity) -> 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 : IGESData_Array1OfIGESEntity) -> IGESData_Array1OfIGESEntity: """ 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 : IGESData_IGESEntity) -> 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) -> IGESData_IGESEntity: ... @overload def __init__(self,theAlloc : Any,theLower : int,theUpper : int) -> None: ... @overload def __init__(self) -> None: ... @overload def __init__(self,theLower : int,theUpper : int) -> None: ... @overload def __init__(self,theOther : IGESData_Array1OfIGESEntity) -> None: ... def __iter__(self) -> Iterator[IGESData_IGESEntity]: ... def __len__(self) -> int: ... pass class IGESData_BasicEditor(): """ This class provides various functions of basic edition, such as : - setting header unit (WARNING : DOES NOT convert entities) - computation of the status (Subordinate, UseFlag) of entities of IGES Entities on a whole model - auto correction of IGES Entities, defined both by DirChecker and by specific service AutoCorrect (this auto correction performs non-ambigious, rather logic, editions) """ def ApplyUnit(self,enforce : bool=False) -> None: """ Applies unit value to convert header data : Resolution, MaxCoord, MaxLineWeight Applies unit only once after SetUnit... has been called, if is given as True. It can be called just before writing the model to a file, i.e. when definitive values are finally known """ def AutoCorrect(self,ent : IGESData_IGESEntity) -> bool: """ Performs auto-correction on an IGESEntity Returns True if something has changed, False if nothing done. """ def AutoCorrectModel(self) -> int: """ Performs auto-correction on the whole Model Returns the count of modified entities """ def ComputeStatus(self) -> None: """ Performs the re-computation of status on the whole model (Subordinate Status and Use Flag of each IGES Entity), which can have required values according the way they are referenced (see definitions of Logical use, Physical use, etc...) """ @staticmethod def DraftingMax_s() -> int: """ Returns the maximum allowed value for Drafting Flag """ @staticmethod def DraftingName_s(flag : int) -> str: """ From the flag of drafting standard, returns name, "" if incorrect """ @staticmethod def IGESVersionMax_s() -> int: """ Returns the maximum allowed value for IGESVersion Flag """ @staticmethod def IGESVersionName_s(flag : int) -> str: """ From the flag of IGES version, returns name, "" if incorrect """ @overload def Init(self,protocol : IGESData_Protocol) -> None: """ Initialize a Basic Editor, with a new IGESModel, ready to run Initialize a Basic Editor for IGES Data, ready to run """ @overload def Init(self,model : IGESData_IGESModel,protocol : IGESData_Protocol) -> None: ... def Model(self) -> IGESData_IGESModel: """ Returns the designated model """ def SetUnitFlag(self,flag : int) -> bool: """ Sets a new unit from its flag (param 14 of Global Section) Returns True if done, False if is incorrect """ def SetUnitName(self,name : str) -> bool: """ Sets a new unit from its name (param 15 of Global Section) Returns True if done, False if is incorrect Remark : if has been set to 3 (user defined), is then free """ def SetUnitValue(self,val : float) -> bool: """ Sets a new unit from its value in meters (rounded to the closest one, max gap 1%) Returns True if done, False if is too far from a suitable value """ @staticmethod def UnitFlagName_s(flag : int) -> str: """ From the flag of unit, determines its name, "" if incorrect """ @staticmethod def UnitFlagValue_s(flag : int) -> float: """ From the flag of unit, determines value in MM, 0 if incorrect """ @staticmethod def UnitNameFlag_s(name : str) -> int: """ From the name of unit, computes flag number, 0 if incorrect (in this case, user defined entity remains possible) """ @overload def __init__(self,protocol : IGESData_Protocol) -> None: ... @overload def __init__(self) -> None: ... @overload def __init__(self,model : IGESData_IGESModel,protocol : IGESData_Protocol) -> None: ... pass class IGESData_IGESEntity(OCP.Standard.Standard_Transient): """ defines root of IGES Entity definition, including Directory Part, lists of (optional) Properties and Associativitiesdefines root of IGES Entity definition, including Directory Part, lists of (optional) Properties and Associativitiesdefines root of IGES Entity definition, including Directory Part, lists of (optional) Properties and Associativities """ def AddProperty(self,ent : IGESData_IGESEntity) -> None: """ Adds a Property in the list """ def ArePresentAssociativities(self) -> bool: """ Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list. """ def ArePresentProperties(self) -> bool: """ Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list """ def Associate(self,ent : IGESData_IGESEntity) -> None: """ Sets "me" in the Associativity list of another Entity """ def Associativities(self) -> OCP.Interface.Interface_EntityIterator: """ Returns the Associativity List under the form of an EntityIterator. """ def BlankStatus(self) -> int: """ gives Blank Status (0 visible, 1 blanked) """ def CResValues(self,res1 : str,res2 : str) -> bool: """ returns "reserved" alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remark : their content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else """ def Color(self) -> IGESData_ColorEntity: """ Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer. """ def CompoundLocation(self) -> OCP.gp.gp_GTrsf: """ Returns Location by taking in account a Parent which has its own Location : that one will be combined to that of The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def DefColor(self) -> IGESData_DefType: """ Returns the definition status of Color. """ def DefLevel(self) -> IGESData_DefList: """ Returns the definition status of Level """ def DefLineFont(self) -> IGESData_DefType: """ Returns the definition status of LineFont """ def DefView(self) -> IGESData_DefList: """ Returns the definition status of the view. This can be: none, one or several. """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DirFieldEntity(self,fieldnum : int) -> IGESData_IGESEntity: """ Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with : 3 : Structure 4 : LineFont 5 : LevelList 6 : View 7 : Transf(ormation Matrix) 8 : LabelDisplay 13 : Color. Other values give a null handle It can then be of any kind, while specific items have a Type """ def Dissociate(self,ent : IGESData_IGESEntity) -> None: """ Resets "me" from the Associativity list of another Entity """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FormNumber(self) -> int: """ Returns the form number for that type of an IGES entity. The default form number is 0. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def HasLabelDisplay(self) -> bool: """ Returns True if a LabelDisplay mode is defined for this entity """ def HasName(self) -> bool: """ says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered) """ def HasOneParent(self) -> bool: """ Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation) """ def HasShortLabel(self) -> bool: """ Returns true if a short label is defined. A short label is a non-blank 8-character string. """ def HasStructure(self) -> bool: """ returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros) """ def HasSubScriptNumber(self) -> bool: """ Returns true if a subscript number is defined. A subscript number is an integer used to identify a label. """ def HasTransf(self) -> bool: """ Returns True if a Transformation Matrix is defined """ def HierarchyStatus(self) -> int: """ gives Hierarchy status (0-1-2) """ def IGESType(self) -> IGESData_IGESType: """ gives IGES typing info (includes "Type" and "Form" data) """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def InitColor(self,ent : IGESData_ColorEntity,rank : int=0) -> None: """ Initializes Color data : if is not Null, it gives Color, else gives or erases (if zero) RankColor """ def InitDirFieldEntity(self,fieldnum : int,ent : IGESData_IGESEntity) -> None: """ Initializes a directory field as an Entiy of any kind See DirFieldEntity for more details """ def InitLevel(self,ent : IGESData_LevelListEntity,val : int=0) -> None: """ Initializes Level : if is not Null, it gives LevelList, else gives or erases (if zero) unique Level """ def InitLineFont(self,ent : IGESData_LineFontEntity,rank : int=0) -> None: """ Initializes LineFont : if is not Null, it gives LineFont, else gives or erases (if zero) RankLineFont """ def InitMisc(self,str : IGESData_IGESEntity,lab : IGESData_LabelDisplayEntity,weightnum : int) -> None: """ Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for ) : for Structure, for LabelDisplay, and for WeightNumber """ def InitStatus(self,blank : int,subordinate : int,useflag : int,hierarchy : int) -> None: """ Initializes the Status of Directory Part """ def InitTransf(self,ent : IGESData_TransfEntity) -> None: """ Initializes Transf, or erases it if is given Null """ def InitView(self,ent : IGESData_ViewKindEntity) -> None: """ Initializes View, or erases it if is given Null """ @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 LabelDisplay(self) -> IGESData_LabelDisplayEntity: """ Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none. """ def Level(self) -> int: """ Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level. """ def LevelList(self) -> IGESData_LevelListEntity: """ Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral. """ def LineFont(self) -> IGESData_LineFontEntity: """ Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not "DefReference" """ def LineWeight(self) -> float: """ Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight """ def LineWeightNumber(self) -> int: """ Returns the LineWeight Number (0 not defined), see also LineWeight """ def Location(self) -> OCP.gp.gp_GTrsf: """ Returns Location given by Transf in Directory Part (see above) It must be considered for local definition : if the Entity is set in a "Parent", that one can add its one Location, but this is not taken in account here : see CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result """ def NameValue(self) -> OCP.TCollection.TCollection_HAsciiString: """ returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name """ def NbAssociativities(self) -> int: """ gives number of recorded associativities (0 no list defined) """ def NbProperties(self) -> int: """ Gives number of recorded properties (0 no list defined) """ def NbTypedAssociativities(self,atype : OCP.Standard.Standard_Type) -> int: """ gives how many Associativities have a given type """ def NbTypedProperties(self,atype : OCP.Standard.Standard_Type) -> int: """ gives how many Properties have a given type """ def Properties(self) -> OCP.Interface.Interface_EntityIterator: """ Returns Property List under the form of an EntityIterator """ def RankColor(self) -> int: """ Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity. """ def RankLineFont(self) -> int: """ Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value """ def RemoveProperty(self,ent : IGESData_IGESEntity) -> None: """ Removes a Property from the list """ def SetLabel(self,label : OCP.TCollection.TCollection_HAsciiString,sub : int=-1) -> None: """ Sets a new Label to an IGES Entity If is given, it sets value of SubScriptNumber else, SubScriptNumber is erased """ def SetLineWeight(self,defw : float,maxw : float,gradw : int) -> None: """ computes and sets "true" line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null """ def ShortLabel(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null. """ def SingleView(self) -> IGESData_ViewKindEntity: """ Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne. """ def Structure(self) -> IGESData_IGESEntity: """ Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined """ def SubScriptNumber(self) -> int: """ Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity. """ def SubordinateStatus(self) -> int: """ gives Subordinate Switch (0-1-2-3) """ 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 Transf(self) -> IGESData_TransfEntity: """ Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation """ def TypeNumber(self) -> int: """ gives IGES Type Number (often coupled with Form Number) """ def TypedAssociativity(self,atype : OCP.Standard.Standard_Type) -> IGESData_IGESEntity: """ returns the Associativity of a given Type (if only one exists) Error if none or more than one """ def TypedProperty(self,atype : OCP.Standard.Standard_Type,anum : int=0) -> IGESData_IGESEntity: """ returns the Property of a given Type Error if none or more than one """ def UniqueParent(self) -> IGESData_IGESEntity: """ Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several """ def UseFlag(self) -> int: """ gives Entity's Use Flag (0 to 5) """ def VectorLocation(self) -> OCP.gp.gp_GTrsf: """ Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition. """ def View(self) -> IGESData_ViewKindEntity: """ Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined. """ def ViewList(self) -> IGESData_ViewKindEntity: """ Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral. """ @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class IGESData_DefList(): """ Some fields of an IGES entity may be - Undefined - Defined as a single item - Defined as a list of items. A typical example, which presents this kind of variation, is a level number. This enumeration allows you to identify which of the above is the case. The semantics of the terms is as follows: - DefNone indicates that the list is empty (there is not even a single item). - DefOne indicates that the list contains a single item. - DefSeveral indicates that the list contains several items. - ErrorOne indicates that the list contains one item, but that this item is incorrect - ErrorSeveral indicates that the list contains several items, but that at least one of them is incorrect. Members: IGESData_DefNone IGESData_DefOne IGESData_DefSeveral IGESData_ErrorOne IGESData_ErrorSeveral """ 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 """ IGESData_DefNone: OCP.IGESData.IGESData_DefList # value = IGESData_DefOne: OCP.IGESData.IGESData_DefList # value = IGESData_DefSeveral: OCP.IGESData.IGESData_DefList # value = IGESData_ErrorOne: OCP.IGESData.IGESData_DefList # value = IGESData_ErrorSeveral: OCP.IGESData.IGESData_DefList # value = __entries: dict # value = {'IGESData_DefNone': (, None), 'IGESData_DefOne': (, None), 'IGESData_DefSeveral': (, None), 'IGESData_ErrorOne': (, None), 'IGESData_ErrorSeveral': (, None)} __members__: dict # value = {'IGESData_DefNone': , 'IGESData_DefOne': , 'IGESData_DefSeveral': , 'IGESData_ErrorOne': , 'IGESData_ErrorSeveral': } pass class IGESData_DefSwitch(): """ description of a directory component which can be either undefined (let Void), defined as a Reference to an entity, or as a Rank, integer value addressing a builtin table The entity reference is not included here, only reference status is kept (because entity type must be adapted) """ def DefType(self) -> IGESData_DefType: """ returns DefType status (Void,Reference,Rank) """ def SetRank(self,val : int) -> None: """ sets DefSwitch to "Rank" with a Value (in file : Integer > 0) """ def SetReference(self) -> None: """ sets DefSwitch to "Reference" Status (in file : Integer < 0) """ def SetVoid(self) -> None: """ sets DefSwitch to "Void" status (in file : Integer = 0) """ def Value(self) -> int: """ returns Value as Integer (sensefull for a Rank) """ def __init__(self) -> None: ... pass class IGESData_DefType(): """ Some fields of an IGES entity may be - Undefined - Defined as a positive integer - Defined as a reference to a specialized entity. A typical example of this kind of variation is color. This enumeration allows you to identify which of the above is the case. The semantics of the terms are as follows: - DefVoid indicates that the item contained in the field is undefined - DefValue indicates that the item is defined as an immediate positive integer value (i.e. not a pointer) - DefReference indicates that the item is defined as an entity - DefAny indicates the item could not be determined - ErrorVal indicates that the item is defined as an integer but its value is incorrect (it could be out of range, for example) - ErrorRef indicates that the item is defined as an entity but is not of the required type. Members: IGESData_DefVoid IGESData_DefValue IGESData_DefReference IGESData_DefAny IGESData_ErrorVal IGESData_ErrorRef """ 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 """ IGESData_DefAny: OCP.IGESData.IGESData_DefType # value = IGESData_DefReference: OCP.IGESData.IGESData_DefType # value = IGESData_DefValue: OCP.IGESData.IGESData_DefType # value = IGESData_DefVoid: OCP.IGESData.IGESData_DefType # value = IGESData_ErrorRef: OCP.IGESData.IGESData_DefType # value = IGESData_ErrorVal: OCP.IGESData.IGESData_DefType # value = __entries: dict # value = {'IGESData_DefVoid': (, None), 'IGESData_DefValue': (, None), 'IGESData_DefReference': (, None), 'IGESData_DefAny': (, None), 'IGESData_ErrorVal': (, None), 'IGESData_ErrorRef': (, None)} __members__: dict # value = {'IGESData_DefVoid': , 'IGESData_DefValue': , 'IGESData_DefReference': , 'IGESData_DefAny': , 'IGESData_ErrorVal': , 'IGESData_ErrorRef': } pass class IGESData_GeneralModule(OCP.Interface.Interface_GeneralModule, OCP.Standard.Standard_Transient): """ Definition of General Services adapted to IGES. This Services comprise : Shared & Implied Lists, Copy, Check They are adapted according to the organisation of IGES Entities : Directory Part, Lists of Associativities and Properties are specifically processedDefinition of General Services adapted to IGES. This Services comprise : Shared & Implied Lists, Copy, Check They are adapted according to the organisation of IGES Entities : Directory Part, Lists of Associativities and Properties are specifically processedDefinition of General Services adapted to IGES. This Services comprise : Shared & Implied Lists, Copy, Check They are adapted according to the organisation of IGES Entities : Directory Part, Lists of Associativities and Properties are specifically processed """ def CanCopy(self,CN : int,ent : OCP.Standard.Standard_Transient) -> bool: """ Specific answer to the question "is Copy properly implemented" For IGES, answer is always True """ def CategoryNumber(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : OCP.Interface.Interface_ShareTool) -> int: """ Returns a category number which characterizes an entity Category Numbers are managed by the class Category can be used to evaluate this number in the context Default returns 0 which means "unspecified" """ def CheckCase(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : OCP.Interface.Interface_ShareTool,ach : OCP.Interface.Interface_Check) -> Any: """ Semantic Checking of an IGESEntity. Performs general Checks, which use DirChecker, then call OwnCheck which does a check specific for each type of Entity """ def CopyCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> 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 DirChecker(self,CN : int,ent : IGESData_IGESEntity) -> IGESData_DirChecker: """ Returns a DirChecker, specific for each type of Entity (identified by its Case Number) : this DirChecker defines constraints which must be respected by the DirectoryPart """ def Dispatch(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> bool: """ Dispatches an entity Returns True if it works by copy, False if it just duplicates the starting Handle """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FillShared(self,model : OCP.Interface.Interface_InterfaceModel,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Specific filling of the list of Entities shared by an Entity , according a Case Number (formerly computed by CaseNum), considered in the context of a Model Default calls FillSharedCase (i.e., ignores the model) Can be redefined to use the model for working """ def FillSharedCase(self,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Fills the list of Entities shared by an IGESEntity , according a Case Number (formerly computed by CaseNum). Considers Properties and Directory Part, and calls OwnSharedCase (which is adapted to each Type of Entity) """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def ListImplied(self,model : OCP.Interface.Interface_InterfaceModel,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ List the Implied References of considered in the context of a Model : i.e. the Entities which are Referenced while not considered as Shared (not copied if is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillShared + ListImplied give the complete list of References Default calls ListImpliedCase (i.e. ignores the model) Can be redefined to use the model for working """ def ListImpliedCase(self,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Lists the Implied References of . Here, these are the Associativities, plus the Entities defined by OwnSharedCase """ def Name(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : OCP.Interface.Interface_ShareTool) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of an IGES Entity (its NameValue) Can be redefined for an even more specific case ... """ def NewCopiedCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> bool: """ Specific operator (create+copy) defaulted to do nothing. It can be redefined : When it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructor : hence the result must be created with an effective definition. Remark : if NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else """ def NewVoid(self,CN : int,entto : OCP.Standard.Standard_Transient) -> bool: """ Specific creation of a new void entity """ def OwnCheckCase(self,CN : int,ent : IGESData_IGESEntity,shares : OCP.Interface.Interface_ShareTool,ach : OCP.Interface.Interface_Check) -> Any: """ Performs Specific Semantic Check for each type of Entity """ def OwnCopyCase(self,CN : int,entfrom : IGESData_IGESEntity,entto : IGESData_IGESEntity,TC : OCP.Interface.Interface_CopyTool) -> None: """ Copies parameters which are specific of each Type of Entity """ def OwnDeleteCase(self,CN : int,ent : IGESData_IGESEntity) -> None: """ Specific preparation for delete, acts on own parameters Default does nothing, to be redefined as required """ def OwnImpliedCase(self,CN : int,ent : IGESData_IGESEntity,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Specific list of Entities implied by a given IGESEntity (in addition to Associativities). By default, there are none, but this method can be redefined as required """ def OwnRenewCase(self,CN : int,entfrom : IGESData_IGESEntity,entto : IGESData_IGESEntity,TC : OCP.Interface.Interface_CopyTool) -> None: """ Renews parameters which are specific of each Type of Entity : the provided default does nothing, but this method may be redefined as required """ def OwnSharedCase(self,CN : int,ent : IGESData_IGESEntity,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Lists the Entities shared by a given IGESEntity , from its specific parameters : specific for each type """ def RenewImpliedCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> None: """ Renewing of Implied References. For IGESEntities, Copies general data(List of Associativities) and calls OwnRenewCase """ def Share(self,iter : OCP.Interface.Interface_EntityIterator,shared : OCP.Standard.Standard_Transient) -> None: """ Adds an Entity to a Shared List (uses GetOneItem on ) """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def WhenDeleteCase(self,CN : int,ent : OCP.Standard.Standard_Transient,dispatched : bool) -> None: """ Prepares an IGES Entity for delete : works on directory part then calls OwnDeleteCase While dispatch requires to copy the entities, is ignored, entities are cleared in any case """ @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class IGESData_SpecificModule(OCP.Standard.Standard_Transient): """ This class defines some Services which are specifically attached to IGES Entities : DumpThis class defines some Services which are specifically attached to IGES Entities : DumpThis class defines some Services which are specifically attached to IGES Entities : Dump """ 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 OwnCorrect(self,CN : int,ent : IGESData_IGESEntity) -> bool: """ Specific Automatic Correction on own Parameters of an Entity. It works by setting in accordance redundant data, if there are when there is no ambiguity (else, it does nothing). Remark that classic Corrections on Directory Entry (to set void data) are taken into account alsewhere. """ def OwnDump(self,CN : int,ent : IGESData_IGESEntity,dumper : IGESData_IGESDumper,S : io.BytesIO,own : int) -> None: """ Specific Dump for each type of IGES Entity : it concerns only own parameters, the general data (Directory Part, Lists) are taken into account by the IGESDumper See class IGESDumper for the rules to follow for and level """ 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 IGESData_DirChecker(): """ This class centralizes general Checks upon an IGES Entity's Directory Part. That is : such field Ignored or Required, or Required with a given Value (for an Integer field) More precise checks can be performed as necessary, by each Entity (method OwnCheck). """ def BlankStatusIgnored(self) -> None: """ Sets Blank Status to be ignored (should not be defined, or its value should be 0) """ def BlankStatusRequired(self,val : int) -> None: """ Sets Blank Status to be required at a given value """ def Check(self,ach : OCP.Interface.Interface_Check,ent : IGESData_IGESEntity) -> Any: """ Performs the Checks on an IGESEntity, according to the recorded criteria In addition, does minimal Checks, such as admitted range for Status, or presence of Error status in some data (Color, ...) """ def CheckTypeAndForm(self,ach : OCP.Interface.Interface_Check,ent : IGESData_IGESEntity) -> Any: """ Performs a Check only on Values of Type Number and Form Number This allows to do a check on an Entity not yet completely filled but of which Type and Form Number have been already set """ def Color(self,crit : IGESData_DefType) -> None: """ Sets Color criterium If crit is DefVoid, Ignored : should not be defined If crit is DefAny, Required : must be defined (value or ref) Other values are not taken in account """ def Correct(self,ent : IGESData_IGESEntity) -> bool: """ Corrects the Directory Entry of an IGES Entity as far as it is possible according recorded criteria without any ambiguity : - if a numeric Status is required a given value, this value is enforced - if an item is required to be Void, or if it recorded as Erroneous, it is cleared (set to Void) - Type Number is enforced - finally Form Number is enforced only if one and only Value is admitted (no range, see Constructors of DirChecker) """ def GraphicsIgnored(self,hierarchy : int=-1) -> None: """ Sets Graphics data (LineFont, LineWeight, Color, Level, View) to be ignored according value of Hierarchy status : If hierarchy is not given, they are Ignored any way (that is, they should not be defined) If hierarchy is given, Graphics are Ignored if the Hierarchy status has the value given in argument "hierarchy" """ def HierarchyStatusIgnored(self) -> None: """ Sets Hierarchy Status to be ignored (should not be defined, or its value should be 0) """ def HierarchyStatusRequired(self,val : int) -> None: """ Sets Hierarchy Status to be required at a given value """ def IsSet(self) -> bool: """ Returns True if at least one criterium has already been set Allows user to store a DirChecker (static variable) then ask if it has been set before setting it """ def LineFont(self,crit : IGESData_DefType) -> None: """ Sets LineFont criterium If crit is DefVoid, Ignored : should not be defined If crit is DefAny, Required : must be defined (value or ref) If crit is DefValue, Required as a Value (error if Reference) Other values are not taken in account """ def LineWeight(self,crit : IGESData_DefType) -> None: """ Sets LineWeight criterium If crit is DefVoid, Ignored : should not be defined If crit is DefValue, Required Other values are not taken in account """ def SetDefault(self) -> None: """ Sets a DirChecker with most current criteria, that is : Structure Ignored ( worths call Structure(crit = DefVoid) ) """ def Structure(self,crit : IGESData_DefType) -> None: """ Sets Structure criterium. If crit is DefVoid, Ignored : should not be defined If crit is DefReference, Required : must be defined Other values are not taken in account """ def SubordinateStatusIgnored(self) -> None: """ Sets Subordinate Status to be ignored (should not be defined, or its value should be 0) """ def SubordinateStatusRequired(self,val : int) -> None: """ Sets Subordinate Status to be required at a given value """ def UseFlagIgnored(self) -> None: """ Sets Blank Status to be ignored (should not be defined, or its value should be 0) """ def UseFlagRequired(self,val : int) -> None: """ Sets Blank Status to be required at a given value Give -1 to demand UseFlag not zero (but no precise value req.) """ @overload def __init__(self,atype : int) -> None: ... @overload def __init__(self,atype : int,aform1 : int,aform2 : int) -> None: ... @overload def __init__(self) -> None: ... @overload def __init__(self,atype : int,aform : int) -> None: ... pass class IGESData_DirPart(): """ literal/numeric description of an entity's directory section, taken from file """ def Init(self,i1 : int,i2 : int,i3 : int,i4 : int,i5 : int,i6 : int,i7 : int,i8 : int,i9 : int,i19 : int,i11 : int,i12 : int,i13 : int,i14 : int,i15 : int,i16 : int,i17 : int,res1 : str,res2 : str,label : str,subscript : str) -> None: """ fills DirPart with consistent data read from file """ def Type(self) -> IGESData_IGESType: """ returns "type" and "form" info, used to recognize the entity """ def Values(self,res1 : str,res2 : str,label : str,subscript : str) -> tuple[int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int]: """ returns values recorded in DirPart (content of cstrings are modified) """ def __init__(self) -> None: ... pass class IGESData_Protocol(OCP.Interface.Interface_Protocol, OCP.Standard.Standard_Transient): """ Description of basic Protocol for IGES This comprises treatment of IGESModel and Recognition of Undefined-FreeFormat-EntityDescription of basic Protocol for IGES This comprises treatment of IGESModel and Recognition of Undefined-FreeFormat-EntityDescription of basic Protocol for IGES This comprises treatment of IGESModel and Recognition of Undefined-FreeFormat-Entity """ @staticmethod def Active_s() -> OCP.Interface.Interface_Protocol: """ Returns the Active Protocol, if defined (else, returns a Null Handle, which means "no defined active protocol") """ def CaseNumber(self,obj : OCP.Standard.Standard_Transient) -> int: """ Returns a unique positive CaseNumber for each Recognized Object. By default, recognition is based on Type(1) By default, calls the following one which is deferred. """ @staticmethod def ClearActive_s() -> None: """ Erases the Active Protocol (hence it becomes undefined) """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def GlobalCheck(self,G : OCP.Interface.Interface_Graph,ach : OCP.Interface.Interface_Check) -> bool: """ Evaluates a Global Check for a model (with its Graph) Returns True when done, False if data in model do not apply """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def IsDynamicType(self,obj : OCP.Standard.Standard_Transient) -> bool: """ Returns True if type of is that defined from CDL This is the default but it may change according implementation """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def IsSuitableModel(self,model : OCP.Interface.Interface_InterfaceModel) -> bool: """ Returns True if is a Model of IGES Norm """ def IsUnknownEntity(self,ent : OCP.Standard.Standard_Transient) -> bool: """ Returns True if is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown """ def NbResources(self) -> int: """ Gives the count of Resource Protocol. Here, none """ def NbTypes(self,obj : OCP.Standard.Standard_Transient) -> int: """ Returns the count of DISTINCT types under which an entity may be processed. Each one is candidate to be recognized by TypeNumber, is then processed according it By default, returns 1 (the DynamicType) """ def NewModel(self) -> OCP.Interface.Interface_InterfaceModel: """ Creates an empty Model for IGES Norm """ def Resource(self,num : int) -> OCP.Interface.Interface_Protocol: """ Returns a Resource, given a rank. Here, none """ @staticmethod def SetActive_s(aprotocol : OCP.Interface.Interface_Protocol) -> None: """ Sets a given Protocol to be the Active one (for the users of Active, see just above). Applies to every sub-type of Protocol """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def Type(self,obj : OCP.Standard.Standard_Transient,nt : int=1) -> OCP.Standard.Standard_Type: """ Returns a type under which can be recognized and processed, according its rank in its definition list (see NbTypes). By default, returns DynamicType """ def TypeNumber(self,atype : OCP.Standard.Standard_Type) -> int: """ Returns a Case Number, specific of each recognized Type Here, Undefined and Free Format Entities have the Number 1. """ def UnknownEntity(self) -> OCP.Standard.Standard_Transient: """ Creates a new Unknown Entity for IGES (UndefinedEntity) """ 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 IGESData_FileRecognizer(OCP.Standard.Standard_Transient): def Add(self,reco : IGESData_FileRecognizer) -> None: """ Adds a new Recognizer to the Compound, at the end Several calls to Add work by adding in the order of calls : Hence, when Eval has failed to recognize, Evaluate will call Evaluate from the first added Recognizer if there is one, and to the second if there is still no result, and so on """ 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 Evaluate(self,akey : IGESData_IGESType,res : IGESData_IGESEntity) -> bool: """ Evaluates if recognition has a result, returns it if yes In case of success, Returns True and puts result in "res" In case of Failure, simply Returns False Works by calling deferred method Eval, and in case of failure, looks for Added Recognizers to work """ 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 Result(self) -> IGESData_IGESEntity: """ Returns result of last recognition (call of Evaluate) """ 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 IGESData_UndefinedEntity(IGESData_IGESEntity, OCP.Standard.Standard_Transient): """ undefined (unknown or error) entity specific of IGES DirPart can be correct or not : if it is not, a flag indicates it, and each corrupted field has an associated error flagundefined (unknown or error) entity specific of IGES DirPart can be correct or not : if it is not, a flag indicates it, and each corrupted field has an associated error flagundefined (unknown or error) entity specific of IGES DirPart can be correct or not : if it is not, a flag indicates it, and each corrupted field has an associated error flag """ def AddProperty(self,ent : IGESData_IGESEntity) -> None: """ Adds a Property in the list """ def ArePresentAssociativities(self) -> bool: """ Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list. """ def ArePresentProperties(self) -> bool: """ Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list """ def Associate(self,ent : IGESData_IGESEntity) -> None: """ Sets "me" in the Associativity list of another Entity """ def Associativities(self) -> OCP.Interface.Interface_EntityIterator: """ Returns the Associativity List under the form of an EntityIterator. """ def BlankStatus(self) -> int: """ gives Blank Status (0 visible, 1 blanked) """ def CResValues(self,res1 : str,res2 : str) -> bool: """ returns "reserved" alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remark : their content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else """ def ChangeableContent(self) -> OCP.Interface.Interface_UndefinedContent: """ Returns own data as an UndefinedContent, in order to touch it """ def Color(self) -> IGESData_ColorEntity: """ Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer. """ def CompoundLocation(self) -> OCP.gp.gp_GTrsf: """ Returns Location by taking in account a Parent which has its own Location : that one will be combined to that of The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def DefColor(self) -> IGESData_DefType: """ returns Error status if necessary, else calls original method """ def DefLevel(self) -> IGESData_DefList: """ returns Error status if necessary, else calls original method """ def DefLineFont(self) -> IGESData_DefType: """ returns Error status if necessary, else calls original method """ def DefView(self) -> IGESData_DefList: """ returns Error status if necessary, else calls original method """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DirFieldEntity(self,fieldnum : int) -> IGESData_IGESEntity: """ Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with : 3 : Structure 4 : LineFont 5 : LevelList 6 : View 7 : Transf(ormation Matrix) 8 : LabelDisplay 13 : Color. Other values give a null handle It can then be of any kind, while specific items have a Type """ def DirStatus(self) -> int: """ returns Directory Error Status (used for Copy) """ def Dissociate(self,ent : IGESData_IGESEntity) -> None: """ Resets "me" from the Associativity list of another Entity """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FormNumber(self) -> int: """ Returns the form number for that type of an IGES entity. The default form number is 0. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def HasLabelDisplay(self) -> bool: """ Returns True if a LabelDisplay mode is defined for this entity """ def HasName(self) -> bool: """ says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered) """ def HasOneParent(self) -> bool: """ Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation) """ def HasShortLabel(self) -> bool: """ Returns true if a short label is defined. A short label is a non-blank 8-character string. """ def HasStructure(self) -> bool: """ returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros) """ def HasSubScriptNumber(self) -> bool: """ returns Error status if necessary, else calls original method (that is, if SubScript field is not blank or positive integer) """ def HasTransf(self) -> bool: """ Returns True if a Transformation Matrix is defined """ def HierarchyStatus(self) -> int: """ gives Hierarchy status (0-1-2) """ def IGESType(self) -> IGESData_IGESType: """ gives IGES typing info (includes "Type" and "Form" data) """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def InitColor(self,ent : IGESData_ColorEntity,rank : int=0) -> None: """ Initializes Color data : if is not Null, it gives Color, else gives or erases (if zero) RankColor """ def InitDirFieldEntity(self,fieldnum : int,ent : IGESData_IGESEntity) -> None: """ Initializes a directory field as an Entiy of any kind See DirFieldEntity for more details """ def InitLevel(self,ent : IGESData_LevelListEntity,val : int=0) -> None: """ Initializes Level : if is not Null, it gives LevelList, else gives or erases (if zero) unique Level """ def InitLineFont(self,ent : IGESData_LineFontEntity,rank : int=0) -> None: """ Initializes LineFont : if is not Null, it gives LineFont, else gives or erases (if zero) RankLineFont """ def InitMisc(self,str : IGESData_IGESEntity,lab : IGESData_LabelDisplayEntity,weightnum : int) -> None: """ Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for ) : for Structure, for LabelDisplay, and for WeightNumber """ def InitStatus(self,blank : int,subordinate : int,useflag : int,hierarchy : int) -> None: """ Initializes the Status of Directory Part """ def InitTransf(self,ent : IGESData_TransfEntity) -> None: """ Initializes Transf, or erases it if is given Null """ def InitView(self,ent : IGESData_ViewKindEntity) -> None: """ Initializes View, or erases it if is given Null """ @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 IsOKDirPart(self) -> bool: """ says if DirPart is OK or not (if not, it is erroneous) Note that if it is not, Def* methods can return Error status """ def LabelDisplay(self) -> IGESData_LabelDisplayEntity: """ Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none. """ def Level(self) -> int: """ Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level. """ def LevelList(self) -> IGESData_LevelListEntity: """ Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral. """ def LineFont(self) -> IGESData_LineFontEntity: """ Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not "DefReference" """ def LineWeight(self) -> float: """ Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight """ def LineWeightNumber(self) -> int: """ Returns the LineWeight Number (0 not defined), see also LineWeight """ def Location(self) -> OCP.gp.gp_GTrsf: """ Returns Location given by Transf in Directory Part (see above) It must be considered for local definition : if the Entity is set in a "Parent", that one can add its one Location, but this is not taken in account here : see CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result """ def NameValue(self) -> OCP.TCollection.TCollection_HAsciiString: """ returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name """ def NbAssociativities(self) -> int: """ gives number of recorded associativities (0 no list defined) """ def NbProperties(self) -> int: """ Gives number of recorded properties (0 no list defined) """ def NbTypedAssociativities(self,atype : OCP.Standard.Standard_Type) -> int: """ gives how many Associativities have a given type """ def NbTypedProperties(self,atype : OCP.Standard.Standard_Type) -> int: """ gives how many Properties have a given type """ def Properties(self) -> OCP.Interface.Interface_EntityIterator: """ Returns Property List under the form of an EntityIterator """ def RankColor(self) -> int: """ Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity. """ def RankLineFont(self) -> int: """ Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value """ def ReadDir(self,IR : IGESData_IGESReaderData,DP : IGESData_DirPart,ach : OCP.Interface.Interface_Check) -> bool: """ Computes the Directory Error Status, to be called before standard ReadDir from IGESReaderTool Returns True if OK (hence, Directory can be loaded), Else returns False and the DirPart is modified (hence, Directory Error Status is non null; and standard Read will work with an acceptable DirectoryPart) """ def ReadOwnParams(self,IR : IGESData_IGESReaderData,PR : IGESData_ParamReader) -> None: """ reads own parameters from file; PR gives access to them, IR detains parameter types and values Here, reads all parameters, integers are considered as entity reference unless they cannot be; no list interpretation No property or associativity list is managed """ def RemoveProperty(self,ent : IGESData_IGESEntity) -> None: """ Removes a Property from the list """ def SetLabel(self,label : OCP.TCollection.TCollection_HAsciiString,sub : int=-1) -> None: """ Sets a new Label to an IGES Entity If is given, it sets value of SubScriptNumber else, SubScriptNumber is erased """ def SetLineWeight(self,defw : float,maxw : float,gradw : int) -> None: """ computes and sets "true" line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null """ def SetNewContent(self,cont : OCP.Interface.Interface_UndefinedContent) -> None: """ Redefines a completely new UndefinedContent Used by a Copy which begins by ShallowCopy, for instance """ def SetOKDirPart(self) -> None: """ Erases the Directory Error Status Warning : Be sure that data are consistent to call this method ... """ def ShortLabel(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null. """ def SingleView(self) -> IGESData_ViewKindEntity: """ Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne. """ def Structure(self) -> IGESData_IGESEntity: """ Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined """ def SubScriptNumber(self) -> int: """ Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity. """ def SubordinateStatus(self) -> int: """ gives Subordinate Switch (0-1-2-3) """ 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 Transf(self) -> IGESData_TransfEntity: """ Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation """ def TypeNumber(self) -> int: """ gives IGES Type Number (often coupled with Form Number) """ def TypedAssociativity(self,atype : OCP.Standard.Standard_Type) -> IGESData_IGESEntity: """ returns the Associativity of a given Type (if only one exists) Error if none or more than one """ def TypedProperty(self,atype : OCP.Standard.Standard_Type,anum : int=0) -> IGESData_IGESEntity: """ returns the Property of a given Type Error if none or more than one """ def UndefinedContent(self) -> OCP.Interface.Interface_UndefinedContent: """ Returns own data as an UndefinedContent """ def UniqueParent(self) -> IGESData_IGESEntity: """ Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several """ def UseFlag(self) -> int: """ gives Entity's Use Flag (0 to 5) """ def VectorLocation(self) -> OCP.gp.gp_GTrsf: """ Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition. """ def View(self) -> IGESData_ViewKindEntity: """ Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined. """ def ViewList(self) -> IGESData_ViewKindEntity: """ Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral. """ def WriteOwnParams(self,IW : IGESData_IGESWriter) -> None: """ writes parameters to IGESWriter, taken from UndefinedContent """ 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 IGESData_DefaultGeneral(IGESData_GeneralModule, OCP.Interface.Interface_GeneralModule, OCP.Standard.Standard_Transient): """ Processes the specific case of UndefinedEntity from IGESData (Case Number 1)Processes the specific case of UndefinedEntity from IGESData (Case Number 1)Processes the specific case of UndefinedEntity from IGESData (Case Number 1) """ def CanCopy(self,CN : int,ent : OCP.Standard.Standard_Transient) -> bool: """ Specific answer to the question "is Copy properly implemented" For IGES, answer is always True """ def CategoryNumber(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : OCP.Interface.Interface_ShareTool) -> int: """ Returns a category number which characterizes an entity Category Numbers are managed by the class Category can be used to evaluate this number in the context Default returns 0 which means "unspecified" """ def CheckCase(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : OCP.Interface.Interface_ShareTool,ach : OCP.Interface.Interface_Check) -> Any: """ Semantic Checking of an IGESEntity. Performs general Checks, which use DirChecker, then call OwnCheck which does a check specific for each type of Entity """ def CopyCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> 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 DirChecker(self,CN : int,ent : IGESData_IGESEntity) -> IGESData_DirChecker: """ Returns a DirChecker, specific for each type of Entity Here, Returns an empty DirChecker (no constraint to check) """ def Dispatch(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> bool: """ Dispatches an entity Returns True if it works by copy, False if it just duplicates the starting Handle """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FillShared(self,model : OCP.Interface.Interface_InterfaceModel,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Specific filling of the list of Entities shared by an Entity , according a Case Number (formerly computed by CaseNum), considered in the context of a Model Default calls FillSharedCase (i.e., ignores the model) Can be redefined to use the model for working """ def FillSharedCase(self,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Fills the list of Entities shared by an IGESEntity , according a Case Number (formerly computed by CaseNum). Considers Properties and Directory Part, and calls OwnSharedCase (which is adapted to each Type of Entity) """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def ListImplied(self,model : OCP.Interface.Interface_InterfaceModel,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ List the Implied References of considered in the context of a Model : i.e. the Entities which are Referenced while not considered as Shared (not copied if is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillShared + ListImplied give the complete list of References Default calls ListImpliedCase (i.e. ignores the model) Can be redefined to use the model for working """ def ListImpliedCase(self,CN : int,ent : OCP.Standard.Standard_Transient,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Lists the Implied References of . Here, these are the Associativities, plus the Entities defined by OwnSharedCase """ def Name(self,CN : int,ent : OCP.Standard.Standard_Transient,shares : OCP.Interface.Interface_ShareTool) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of an IGES Entity (its NameValue) Can be redefined for an even more specific case ... """ def NewCopiedCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> bool: """ Specific operator (create+copy) defaulted to do nothing. It can be redefined : When it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructor : hence the result must be created with an effective definition. Remark : if NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else """ def NewVoid(self,CN : int,entto : OCP.Standard.Standard_Transient) -> bool: """ Specific creation of a new void entity (UndefinedEntity only) """ def OwnCheckCase(self,CN : int,ent : IGESData_IGESEntity,shares : OCP.Interface.Interface_ShareTool,ach : OCP.Interface.Interface_Check) -> Any: """ Performs Specific Semantic Check for each type of Entity Here, does nothing (no constraint to check) """ def OwnCopyCase(self,CN : int,entfrom : IGESData_IGESEntity,entto : IGESData_IGESEntity,TC : OCP.Interface.Interface_CopyTool) -> None: """ Copies parameters which are specific of each Type of Entity """ def OwnDeleteCase(self,CN : int,ent : IGESData_IGESEntity) -> None: """ Specific preparation for delete, acts on own parameters Default does nothing, to be redefined as required """ def OwnImpliedCase(self,CN : int,ent : IGESData_IGESEntity,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Specific list of Entities implied by a given IGESEntity (in addition to Associativities). By default, there are none, but this method can be redefined as required """ def OwnRenewCase(self,CN : int,entfrom : IGESData_IGESEntity,entto : IGESData_IGESEntity,TC : OCP.Interface.Interface_CopyTool) -> None: """ Renews parameters which are specific of each Type of Entity : the provided default does nothing, but this method may be redefined as required """ def OwnSharedCase(self,CN : int,ent : IGESData_IGESEntity,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Lists the Entities shared by an IGESEntity, which must be an UndefinedEntity """ def RenewImpliedCase(self,CN : int,entfrom : OCP.Standard.Standard_Transient,entto : OCP.Standard.Standard_Transient,TC : OCP.Interface.Interface_CopyTool) -> None: """ Renewing of Implied References. For IGESEntities, Copies general data(List of Associativities) and calls OwnRenewCase """ def Share(self,iter : OCP.Interface.Interface_EntityIterator,shared : OCP.Standard.Standard_Transient) -> None: """ Adds an Entity to a Shared List (uses GetOneItem on ) """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def WhenDeleteCase(self,CN : int,ent : OCP.Standard.Standard_Transient,dispatched : bool) -> None: """ Prepares an IGES Entity for delete : works on directory part then calls OwnDeleteCase While dispatch requires to copy the entities, is ignored, entities are cleared in any case """ 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 IGESData_GlobalNodeOfSpecificLib(OCP.Standard.Standard_Transient): def Add(self,amodule : IGESData_SpecificModule,aprotocol : IGESData_Protocol) -> None: """ Adds a Module bound with a Protocol to the list : does nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondence """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def Module(self) -> IGESData_SpecificModule: """ Returns the Module stored in a given GlobalNode """ def Next(self) -> IGESData_GlobalNodeOfSpecificLib: """ Returns the Next GlobalNode. If none is defined, returned value is a Null Handle """ def Protocol(self) -> IGESData_Protocol: """ Returns the attached Protocol stored in a given GlobalNode """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class IGESData_GlobalNodeOfWriterLib(OCP.Standard.Standard_Transient): def Add(self,amodule : IGESData_ReadWriteModule,aprotocol : IGESData_Protocol) -> None: """ Adds a Module bound with a Protocol to the list: does nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required). Once added, stores its attached Protocol in correspondence """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def Module(self) -> IGESData_ReadWriteModule: """ Returns the Module stored in a given GlobalNode """ def Next(self) -> IGESData_GlobalNodeOfWriterLib: """ Returns the Next GlobalNode. If none is defined, returned value is a Null Handle """ def Protocol(self) -> IGESData_Protocol: """ Returns the attached Protocol stored in a given GlobalNode """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class IGESData_GlobalSection(): """ Description of a global section (corresponds to file header) used as well in IGESModel, IGESReader and IGESWriter Warning : From IGES-5.1, a parameter is added : LastChangeDate (concerns transferred set of data, not the file itself) Of course, it can be absent if read from earlier versions (a default is then to be set to current date) From 5.3, one more : ApplicationProtocol (optional) """ def ApplicationProtocol(self) -> OCP.TCollection.TCollection_HAsciiString: """ None """ def AuthorName(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the IGES file author. """ def CascadeUnit(self) -> float: """ Returns the system length unit """ def CompanyName(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the company where the IGES file was written. """ def CopyRefs(self) -> None: """ Copies data referenced by Handle (that is, Strings) useful to "isolate" a GlobalSection after copy by "=" (from a Model to another Model for instance) """ def Date(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the IGES file creation date. """ def DraftingStandard(self) -> int: """ None """ def EndMark(self) -> str: """ Returns the record delimiter character. """ def FileName(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the IGES file. """ def HasApplicationProtocol(self) -> bool: """ None """ def HasLastChangeDate(self) -> bool: """ Returns True if the date and time when the model was created or last modified are specified, i.e. not defaulted to NULL. """ def HasMaxCoord(self) -> bool: """ Returns True if the approximate maximum coordinate value found in the model is greater than 0. """ def IGESVersion(self) -> int: """ Returns the IGES version that the IGES file was written in. """ def Init(self,params : OCP.Interface.Interface_ParamSet,ach : OCP.Interface.Interface_Check) -> Any: """ Fills GlobalSection from a ParamSet (i.e. taken from file) undefined parameters do not change default values when defined Fills Check about Corrections or Fails """ def IntegerBits(self) -> int: """ Returns the number of binary bits for integer representations. """ def InterfaceVersion(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the pre-processor used to write the IGES file. """ def LastChangeDate(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the date and time when the model was created or last modified (for IGES 5.1 and later). """ def LineWeightGrad(self) -> int: """ Returns the maximum number of line weight gradations. """ def MaxCoord(self) -> float: """ Returns the approximate maximum coordinate value found in the model. """ def MaxDigitsDouble(self) -> int: """ None """ def MaxDigitsSingle(self) -> int: """ None """ def MaxLineWeight(self) -> float: """ Returns the of maximum line weight width in IGES file units. """ def MaxMaxCoord(self,val : float=0.0) -> None: """ None """ def MaxMaxCoords(self,xyz : OCP.gp.gp_XYZ) -> None: """ None """ def MaxPower10Double(self) -> int: """ Returns the maximum power of a decimal representation of a double-precision floating point number in the sending system. """ def MaxPower10Single(self) -> int: """ Returns the maximum power of a decimal representation of a single-precision floating point number in the sending system. """ @staticmethod @overload def NewDateString_s(date : OCP.TCollection.TCollection_HAsciiString,mode : int=1) -> OCP.TCollection.TCollection_HAsciiString: """ Returns a string built from year, month, day, hour, minute and second values. The form of the resulting string is defined as follows: - -1: YYMMDD.HHNNSS, - 0: YYYYMMDD.HHNNSS, - 1: YYYY-MM-DD:HH-NN-SS, where: - YYYY or YY is 4 or 2 digit year, - HH is hour (00-23), - MM is month (01-12), - NN is minute (00-59) - DD is day (01-31), - SS is second (00-59). Converts the string given in the form YYMMDD.HHNNSS or YYYYMMDD.HHNNSS to either YYMMDD.HHNNSS, YYYYMMDD.HHNNSS or YYYY-MM-DD:HH-NN-SS. """ @staticmethod @overload def NewDateString_s(year : int,month : int,day : int,hour : int,minut : int,second : int,mode : int=-1) -> OCP.TCollection.TCollection_HAsciiString: ... def Params(self) -> OCP.Interface.Interface_ParamSet: """ Returns all contained data in the form of a ParamSet Remark : Strings are given under Hollerith form """ def ReceiveName(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the receiving system. """ def Resolution(self) -> float: """ Returns the resolution used in the IGES file. """ def Scale(self) -> float: """ Returns the scale used in the IGES file. """ def SendName(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the sending system. """ def Separator(self) -> str: """ Returns the parameter delimiter character. """ def SetApplicationProtocol(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetAuthorName(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetCascadeUnit(self,theUnit : float) -> None: """ None """ def SetCompanyName(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetDate(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetDraftingStandard(self,val : int) -> None: """ None """ def SetEndMark(self,val : str) -> None: """ None """ def SetFileName(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetIGESVersion(self,val : int) -> None: """ None """ def SetIntegerBits(self,val : int) -> None: """ None """ def SetInterfaceVersion(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ @overload def SetLastChangeDate(self) -> None: """ None None """ @overload def SetLastChangeDate(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: ... def SetLineWeightGrad(self,val : int) -> None: """ None """ def SetMaxCoord(self,val : float=0.0) -> None: """ None """ def SetMaxDigitsDouble(self,val : int) -> None: """ None """ def SetMaxDigitsSingle(self,val : int) -> None: """ None """ def SetMaxLineWeight(self,val : float) -> None: """ None """ def SetMaxPower10Double(self,val : int) -> None: """ None """ def SetMaxPower10Single(self,val : int) -> None: """ None """ def SetReceiveName(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetResolution(self,val : float) -> None: """ None """ def SetScale(self,val : float) -> None: """ None """ def SetSendName(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetSeparator(self,val : str) -> None: """ None """ def SetSystemId(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SetUnitFlag(self,val : int) -> None: """ None """ def SetUnitName(self,val : OCP.TCollection.TCollection_HAsciiString) -> None: """ None """ def SystemId(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the Native System ID of the system that created the IGES file. """ def TranslatedFromHollerith(self,astr : OCP.TCollection.TCollection_HAsciiString) -> OCP.TCollection.TCollection_HAsciiString: """ Returns a string withpout its Hollerith marks (nnnH ahead). Remark : all strings stored in GlobalSection are expurged from Hollerith information (without nnnH) If is not Hollerith form, it is simply copied """ def UnitFlag(self) -> int: """ Returns the unit flag that was used to write the IGES file. """ def UnitName(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the name of the unit the IGES file was written in. """ def UnitValue(self) -> float: """ Returns the unit value (in meters) that the IGES file was written in. """ def __init__(self) -> None: ... pass class IGESData_HArray1OfIGESEntity(IGESData_Array1OfIGESEntity, OCP.Standard.Standard_Transient): def Array1(self) -> IGESData_Array1OfIGESEntity: """ None """ def Assign(self,theOther : IGESData_Array1OfIGESEntity) -> IGESData_Array1OfIGESEntity: """ 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) -> IGESData_Array1OfIGESEntity: """ 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 : IGESData_IGESEntity) -> 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 : IGESData_Array1OfIGESEntity) -> IGESData_Array1OfIGESEntity: """ 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 : IGESData_IGESEntity) -> 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) -> IGESData_IGESEntity: ... @overload def __init__(self,theBegin : IGESData_IGESEntity,theLower : int,theUpper : int,arg4 : bool) -> None: ... @overload def __init__(self) -> None: ... @overload def __init__(self,theOther : IGESData_Array1OfIGESEntity) -> None: ... @overload def __init__(self,theLower : int,theUpper : int) -> None: ... @overload def __init__(self,theLower : int,theUpper : int,theValue : IGESData_IGESEntity) -> None: ... def __iter__(self) -> Iterator[IGESData_IGESEntity]: ... 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 IGESData_IGESDumper(): """ Provides a way to obtain a clear Dump of an IGESEntity (distinct from normalized output). It works with tools attached to Entities, as for normalized Reade and Write """ def Dump(self,ent : IGESData_IGESEntity,S : io.BytesIO,own : int,attached : int=-1) -> None: """ None """ def OwnDump(self,ent : IGESData_IGESEntity,S : io.BytesIO,own : int) -> None: """ Specific Dump for each IGES Entity, call by Dump (just above) is the parameter from Dump """ def PrintDNum(self,ent : IGESData_IGESEntity,S : io.BytesIO) -> None: """ Prints onto an output, the "Number of Directory Entry" which corresponds to an IGESEntity in the IGESModel, under the form "D#nnn" (a Null Handle gives D#0) """ def PrintShort(self,ent : IGESData_IGESEntity,S : io.BytesIO) -> None: """ Prints onto an output, the "Number of Directory Entry" (see PrintDNum) plus IGES Type and Form Numbers, which gives "D#nnn Type nnn Form nnn" """ def __init__(self,model : IGESData_IGESModel,protocol : IGESData_Protocol) -> None: ... pass class IGESData_ColorEntity(IGESData_IGESEntity, OCP.Standard.Standard_Transient): """ defines required type for Color in directory part an effective Color entity must inherits itdefines required type for Color in directory part an effective Color entity must inherits itdefines required type for Color in directory part an effective Color entity must inherits it """ def AddProperty(self,ent : IGESData_IGESEntity) -> None: """ Adds a Property in the list """ def ArePresentAssociativities(self) -> bool: """ Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list. """ def ArePresentProperties(self) -> bool: """ Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list """ def Associate(self,ent : IGESData_IGESEntity) -> None: """ Sets "me" in the Associativity list of another Entity """ def Associativities(self) -> OCP.Interface.Interface_EntityIterator: """ Returns the Associativity List under the form of an EntityIterator. """ def BlankStatus(self) -> int: """ gives Blank Status (0 visible, 1 blanked) """ def CResValues(self,res1 : str,res2 : str) -> bool: """ returns "reserved" alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remark : their content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else """ def Color(self) -> IGESData_ColorEntity: """ Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer. """ def CompoundLocation(self) -> OCP.gp.gp_GTrsf: """ Returns Location by taking in account a Parent which has its own Location : that one will be combined to that of The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def DefColor(self) -> IGESData_DefType: """ Returns the definition status of Color. """ def DefLevel(self) -> IGESData_DefList: """ Returns the definition status of Level """ def DefLineFont(self) -> IGESData_DefType: """ Returns the definition status of LineFont """ def DefView(self) -> IGESData_DefList: """ Returns the definition status of the view. This can be: none, one or several. """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DirFieldEntity(self,fieldnum : int) -> IGESData_IGESEntity: """ Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with : 3 : Structure 4 : LineFont 5 : LevelList 6 : View 7 : Transf(ormation Matrix) 8 : LabelDisplay 13 : Color. Other values give a null handle It can then be of any kind, while specific items have a Type """ def Dissociate(self,ent : IGESData_IGESEntity) -> None: """ Resets "me" from the Associativity list of another Entity """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FormNumber(self) -> int: """ Returns the form number for that type of an IGES entity. The default form number is 0. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def HasLabelDisplay(self) -> bool: """ Returns True if a LabelDisplay mode is defined for this entity """ def HasName(self) -> bool: """ says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered) """ def HasOneParent(self) -> bool: """ Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation) """ def HasShortLabel(self) -> bool: """ Returns true if a short label is defined. A short label is a non-blank 8-character string. """ def HasStructure(self) -> bool: """ returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros) """ def HasSubScriptNumber(self) -> bool: """ Returns true if a subscript number is defined. A subscript number is an integer used to identify a label. """ def HasTransf(self) -> bool: """ Returns True if a Transformation Matrix is defined """ def HierarchyStatus(self) -> int: """ gives Hierarchy status (0-1-2) """ def IGESType(self) -> IGESData_IGESType: """ gives IGES typing info (includes "Type" and "Form" data) """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def InitColor(self,ent : IGESData_ColorEntity,rank : int=0) -> None: """ Initializes Color data : if is not Null, it gives Color, else gives or erases (if zero) RankColor """ def InitDirFieldEntity(self,fieldnum : int,ent : IGESData_IGESEntity) -> None: """ Initializes a directory field as an Entiy of any kind See DirFieldEntity for more details """ def InitLevel(self,ent : IGESData_LevelListEntity,val : int=0) -> None: """ Initializes Level : if is not Null, it gives LevelList, else gives or erases (if zero) unique Level """ def InitLineFont(self,ent : IGESData_LineFontEntity,rank : int=0) -> None: """ Initializes LineFont : if is not Null, it gives LineFont, else gives or erases (if zero) RankLineFont """ def InitMisc(self,str : IGESData_IGESEntity,lab : IGESData_LabelDisplayEntity,weightnum : int) -> None: """ Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for ) : for Structure, for LabelDisplay, and for WeightNumber """ def InitStatus(self,blank : int,subordinate : int,useflag : int,hierarchy : int) -> None: """ Initializes the Status of Directory Part """ def InitTransf(self,ent : IGESData_TransfEntity) -> None: """ Initializes Transf, or erases it if is given Null """ def InitView(self,ent : IGESData_ViewKindEntity) -> None: """ Initializes View, or erases it if is given Null """ @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 LabelDisplay(self) -> IGESData_LabelDisplayEntity: """ Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none. """ def Level(self) -> int: """ Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level. """ def LevelList(self) -> IGESData_LevelListEntity: """ Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral. """ def LineFont(self) -> IGESData_LineFontEntity: """ Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not "DefReference" """ def LineWeight(self) -> float: """ Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight """ def LineWeightNumber(self) -> int: """ Returns the LineWeight Number (0 not defined), see also LineWeight """ def Location(self) -> OCP.gp.gp_GTrsf: """ Returns Location given by Transf in Directory Part (see above) It must be considered for local definition : if the Entity is set in a "Parent", that one can add its one Location, but this is not taken in account here : see CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result """ def NameValue(self) -> OCP.TCollection.TCollection_HAsciiString: """ returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name """ def NbAssociativities(self) -> int: """ gives number of recorded associativities (0 no list defined) """ def NbProperties(self) -> int: """ Gives number of recorded properties (0 no list defined) """ def NbTypedAssociativities(self,atype : OCP.Standard.Standard_Type) -> int: """ gives how many Associativities have a given type """ def NbTypedProperties(self,atype : OCP.Standard.Standard_Type) -> int: """ gives how many Properties have a given type """ def Properties(self) -> OCP.Interface.Interface_EntityIterator: """ Returns Property List under the form of an EntityIterator """ def RankColor(self) -> int: """ Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity. """ def RankLineFont(self) -> int: """ Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value """ def RemoveProperty(self,ent : IGESData_IGESEntity) -> None: """ Removes a Property from the list """ def SetLabel(self,label : OCP.TCollection.TCollection_HAsciiString,sub : int=-1) -> None: """ Sets a new Label to an IGES Entity If is given, it sets value of SubScriptNumber else, SubScriptNumber is erased """ def SetLineWeight(self,defw : float,maxw : float,gradw : int) -> None: """ computes and sets "true" line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null """ def ShortLabel(self) -> OCP.TCollection.TCollection_HAsciiString: """ Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null. """ def SingleView(self) -> IGESData_ViewKindEntity: """ Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne. """ def Structure(self) -> IGESData_IGESEntity: """ Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined """ def SubScriptNumber(self) -> int: """ Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity. """ def SubordinateStatus(self) -> int: """ gives Subordinate Switch (0-1-2-3) """ 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 Transf(self) -> IGESData_TransfEntity: """ Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation """ def TypeNumber(self) -> int: """ gives IGES Type Number (often coupled with Form Number) """ def TypedAssociativity(self,atype : OCP.Standard.Standard_Type) -> IGESData_IGESEntity: """ returns the Associativity of a given Type (if only one exists) Error if none or more than one """ def TypedProperty(self,atype : OCP.Standard.Standard_Type,anum : int=0) -> IGESData_IGESEntity: """ returns the Property of a given Type Error if none or more than one """ def UniqueParent(self) -> IGESData_IGESEntity: """ Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several """ def UseFlag(self) -> int: """ gives Entity's Use Flag (0 to 5) """ def VectorLocation(self) -> OCP.gp.gp_GTrsf: """ Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition. """ def View(self) -> IGESData_ViewKindEntity: """ Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined. """ def ViewList(self) -> IGESData_ViewKindEntity: """ Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral. """ 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 IGESData_IGESModel(OCP.Interface.Interface_InterfaceModel, OCP.Standard.Standard_Transient): """ Defines the file header and entities for IGES files. These headers and entities result from a complete data translation using the IGES data exchange processor. Each entity is contained in a single model only and has a unique identifier. You can access this identifier using the method Number. Gives an access to the general data in the Start and the Global sections of an IGES file. The IGES file includes the following sections: -Start, -Global, -Directory Entry, -Parameter Data, -TerminateDefines the file header and entities for IGES files. These headers and entities result from a complete data translation using the IGES data exchange processor. Each entity is contained in a single model only and has a unique identifier. You can access this identifier using the method Number. Gives an access to the general data in the Start and the Global sections of an IGES file. The IGES file includes the following sections: -Start, -Global, -Directory Entry, -Parameter Data, -TerminateDefines the file header and entities for IGES files. These headers and entities result from a complete data translation using the IGES data exchange processor. Each entity is contained in a single model only and has a unique identifier. You can access this identifier using the method Number. Gives an access to the general data in the Start and the Global sections of an IGES file. The IGES file includes the following sections: -Start, -Global, -Directory Entry, -Parameter Data, -Terminate """ def AddEntity(self,anentity : OCP.Standard.Standard_Transient) -> None: """ Internal method for adding an Entity. Used by file reading (defined by each Interface) and Transfer tools. It adds the entity required to be added, not its refs : see AddWithRefs. If is a ReportEntity, it is added to the list of Reports, its Concerned Entity (Erroneous or Corrected, else Unknown) is added to the list of Entities. That is, the ReportEntity must be created before Adding """ def AddReportEntity(self,rep : OCP.Interface.Interface_ReportEntity,semantic : bool=False) -> bool: """ Adds a ReportEntity as such. Returns False if the concerned entity is not recorded in the Model Else, adds it into, either the main report list or the list for semantic checks, then returns True """ def AddStartLine(self,line : str,atnum : int=0) -> None: """ Adds a new string to the existing Start section at the end if atnum is 0 or not given, or before atnumth line. """ @overload def AddWithRefs(self,anent : OCP.Standard.Standard_Transient,lib : OCP.Interface.Interface_GeneralLib,level : int=0,listall : bool=False) -> None: """ Adds to the Model, an Entity with all its References, as they are defined by General Services FillShared and ListImplied. Process is recursive (any sub-levels) if = 0 (Default) Else, adds sub-entities until the required sub-level. Especially, if = 1, adds immediate subs and that's all Same as above, but works with the Protocol of the Model Same as above, but works with an already created GeneralLib """ @overload def AddWithRefs(self,anent : OCP.Standard.Standard_Transient,proto : OCP.Interface.Interface_Protocol,level : int=0,listall : bool=False) -> None: ... @overload def AddWithRefs(self,anent : OCP.Standard.Standard_Transient,level : int=0,listall : bool=False) -> None: ... def ApplyStatic(self,param : str='') -> bool: """ Sets some of the Global section parameters with the values defined by the translation parameters. param may be: - receiver (value read in XSTEP.iges.header.receiver), - author (value read in XSTEP.iges.header.author), - company (value read in XSTEP.iges.header.company). The default value for param is an empty string. Returns True when done and if param is given, False if param is unknown or empty. Note: Set the unit in the IGES file Global section via IGESData_BasicEditor class. """ def CategoryNumber(self,num : int) -> int: """ Returns the recorded category number for a given entity number 0 if none was defined for this entity """ def ChangeGlobalSection(self) -> IGESData_GlobalSection: """ Returns the Global section of the IGES file. """ def ChangeOrder(self,oldnum : int,newnum : int,count : int=1) -> None: """ Changes the Numbers of some Entities : is moved to , same for entities. Thus : 1,2 ... newnum-1 newnum ... oldnum .. oldnum+count oldnum+count+1 .. gives 1,2 ... newnum-1 oldnum .. oldnum+count newnum ... oldnum+count+1 (can be seen as a circular permutation) """ def Check(self,num : int,syntactic : bool) -> OCP.Interface.Interface_Check: """ Returns the check attached to an entity, designated by its Number. 0 for global check True : recorded semantic check False : recorded syntactic check (see ReportEntity) If no check is recorded for , returns an empty Check """ @staticmethod def ClassName_s(typnam : str) -> str: """ From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed """ def Clear(self) -> None: """ Erases contained data; used when a Model is copied to others : the new copied ones begin from clear Clear calls specific method ClearHeader (see below) """ def ClearEntities(self) -> None: """ Clears the entities; uses the general service WhenDelete, in addition to the standard Memory Manager; can be redefined """ def ClearHeader(self) -> None: """ Erases all data specific to IGES file Header (Start + Global) """ def ClearLabels(self) -> None: """ erases specific labels, i.e. does nothing """ def ClearReportEntity(self,num : int) -> bool: """ Removes the ReportEntity attached to Entity . Returns True if done, False if no ReportEntity was attached to . Warning : the caller must assume that this clearing is meaningful """ def ClearStartSection(self) -> None: """ Clears the IGES file Start Section """ def Contains(self,anentity : OCP.Standard.Standard_Transient) -> bool: """ Returns True if a Model contains an Entity (for a ReportEntity, looks for the ReportEntity itself AND its Concerned Entity) """ def DNum(self,ent : IGESData_IGESEntity) -> int: """ Returns the equivalent DE Number for an Entity, i.e. 2*Number(ent)-1 , or 0 if is unknown from This DE Number is used for File Writing for instance """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def Destroy(self) -> None: """ Clears the list of entities (service WhenDelete) """ def DumpHeader(self,S : io.BytesIO,level : int=0) -> None: """ Prints the IGES file header (Start and Global Sections) to the log file. The integer parameter is intended to be used as a level indicator but is not used at present. """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def Entities(self) -> OCP.Interface.Interface_EntityIterator: """ Returns the list of all Entities, as an Iterator on Entities (the Entities themselves, not the Reports) """ def Entity(self,num : int) -> IGESData_IGESEntity: """ Returns an IGES entity given by its rank number. """ def EntityState(self,num : int) -> OCP.Interface.Interface_DataState: """ Returns the State of an entity, given its number """ def FillIterator(self,iter : OCP.Interface.Interface_EntityIterator) -> None: """ Allows an EntityIterator to get a list of Entities """ def FillSemanticChecks(self,checks : OCP.Interface.Interface_CheckIterator,clear : bool=True) -> None: """ Fills the list of semantic checks. This list is computed (by CheckTool). Hence, it can be stored in the model for later queries True (D) : new list replaces False : new list is cumulated """ def GTool(self) -> OCP.Interface.Interface_GTool: """ Returns the GTool, set by SetProtocol or by SetGTool """ def GetFromAnother(self,other : OCP.Interface.Interface_InterfaceModel) -> None: """ gets Header (GlobalSection) from another Model """ def GetFromTransfer(self,aniter : OCP.Interface.Interface_EntityIterator) -> None: """ Gets contents from an EntityIterator, prepared by a Transfer tool (e.g TransferCopy). Starts from clear """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def GlobalCheck(self,syntactic : bool=True) -> OCP.Interface.Interface_Check: """ Returns the GlobalCheck, which memorizes messages global to the file (not specific to an Entity), especially Header """ def GlobalSection(self) -> IGESData_GlobalSection: """ Returns the Global section of the IGES file. """ def HasSemanticChecks(self) -> bool: """ Returns True if semantic checks have been filled """ @staticmethod def HasTemplate_s(name : str) -> bool: """ Returns true if a template is attached to a given name """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def IsErrorEntity(self,num : int) -> bool: """ Returns True if identifies an Error Entity : in this case, a ReportEntity brings Fail Messages and possibly an "undefined" Content, see IsRedefinedEntity """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def IsRedefinedContent(self,num : int) -> bool: """ Returns True if identifies an Entity which content is redefined through a ReportEntity (i.e. with literal data only) This happens when an entity is syntactically erroneous in the way that its basic content remains empty. For more details (such as content itself), see ReportEntity """ def IsReportEntity(self,num : int,semantic : bool=False) -> bool: """ Returns True if identifies a ReportEntity in the Model Hence, ReportEntity can be called. """ def IsUnknownEntity(self,num : int) -> bool: """ Returns True if identifies an Unknown Entity : in this case, a ReportEntity with no Check Messages designates it. """ @staticmethod def ListTemplates_s() -> OCP.TColStd.TColStd_HSequenceOfHAsciiString: """ Returns the complete list of names attached to template models """ def NbEntities(self) -> int: """ Returns count of contained Entities """ def NbStartLines(self) -> int: """ Returns the count of recorded Start Lines """ def NbTypes(self,ent : OCP.Standard.Standard_Transient) -> int: """ Returns the count of DISTINCT types under which an entity may be processed. Defined by the Protocol, which gives default as 1 (dynamic Type). """ def NewEmptyModel(self) -> OCP.Interface.Interface_InterfaceModel: """ Returns a New Empty Model, same type as i.e. IGESModel """ def NextNumberForLabel(self,label : str,lastnum : int=0,exact : bool=True) -> int: """ Searches a label which matches with one entity. Begins from +1 (default:1) and scans the entities until . For the first which matches