pycatia.analysis_interfaces.analysis_local_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_local_entities.AnalysisLocalEntities(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
AnalysisLocalEntities

The collection of local analysis entities.
add(i_type: str) → AnalysisLocalEntity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Add(CATBSTR iType) As AnalysisLocalEntity

Creates a new analysis local entity and adds it to the analysis entities
collection.
This collection may be extracted from an analysis entity.The Analysis local
entity will be created on the Analysis entity.

Parameters:

iType
The type of the entity to create.

Returns:
The created analysis entity
Example:

This example create ThisAnalysisEntity in the analysisEntities
collection

The entity to create is supposed to be a pressure defined in a load
set.



Dim analysisEntities As CATIAAnalysisLocalEntities
Dim ThisAnalysisEntity As AnalysisEntity
Set ThisAnalysisEntity = analysisEntities.Add(“SAMShellLocal”)
Parameters:

i_type (str) –

Return type:

AnalysisLocalEntity

item(i_index: cat_variant) → AnalysisLocalEntity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As AnalysisLocalEntity

Returns an analysis entity using its index or its name from the analysis
entities collection.

Parameters:

iIndex
The index or the name of the analysis entity to retrieve from the
collection of analysis entities. As a numerics, this index is the rank of the
analysis entity in the collection. The index of the first analysis entity in
the collection is 1, and the index of the last analysis entity is Count. As a
string, it is the name you assigned to the analysis entity using the


AnyObject.Name property or when creating it using the Add method.

Returns:
The retrieved analysis entity
Parameters:

i_index (cat_variant) –

Return type:

AnalysisLocalEntity

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Remove(CATVariant iIndex)

Returns an analysis local entity.

Parameters:

iIndex
The index or the name of the analysis entity to retrieve from the
collection of analysis entities. As a numerics, this index is the rank of the
analysis entity in the collection. The index of the first analysis entity in
the collection is 1, and the index of the last analysis entity is Count. As a
string, it is the name you assigned to the analysis entity using the


AnyObject.Name property or when creating it using the Add method.
Parameters:

i_index (cat_variant) –

Return type:

None