pycatia.analysis_interfaces.analysis_entities¶
Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357
Warning
The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.
- class pycatia.analysis_interfaces.analysis_entities.AnalysisEntities(com_object)¶
Note
CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.CollectionAnalysisEntitiesThe collection of analysis entities.- add(i_type: str) AnalysisEntity ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func Add(CATBSTR iType) As AnalysisEntityCreates a new analysis entity and adds it to the analysis entitiescollection.This collection may be extracted from an analysis set.The Analysis entitywill be created on the Analysis Model.Parameters:iTypeThe type of the entity to create.Returns:The created analysis entityExample:This example create ThisAnalysisEntity in the analysisEntitiescollectionThe entity to create is supposed to be a pressure defined in a loadset.Dim analysisEntities As CATIAAnalysisEntitiesDim ThisAnalysisEntity As AnalysisEntitySet ThisAnalysisEntity = analysisEntities.Add(“SAMPressure”)
- Parameters:
i_type (str) –
- Return type:
- item(i_index: cat_variant) AnalysisEntity ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func Item(CATVariant iIndex) As AnalysisEntityReturns an analysis entity using its index or its name from the analysisentities collection.Parameters:iIndexThe index or the name of the analysis entity to retrieve from thecollection of analysis entities. As a numerics, this index is the rank of theanalysis entity in the collection. The index of the first analysis entity inthe collection is 1, and the index of the last analysis entity is Count. As astring, it is the name you assigned to the analysis entity using theAnyObject.Name property or when creating it using the Add method.Returns:The retrieved analysis entity
- Parameters:
i_index (cat_variant) –
- Return type:
- remove(i_index: cat_variant) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub Remove(CATVariant iIndex)Removes a entity using its index or its name from the entitycollection.Parameters:iIndexThe index or the name of the entity to retrieve from the collectionof entities. As a numeric, this index is the rank of the entity in thecollection. The index of the first entity in the collection is 1, and the indexof the last entity is Count. As a string, it is the name you assigned to theentity using theAnyObject.Name property.
- Parameters:
i_index (cat_variant) –
- Return type:
None