pycatia.analysis_interfaces.analysis_output_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_output_entities.AnalysisOutputEntities(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
AnalysisOutputEntities

The collection of analysis entities results of a set.
This collection is implemented only for analysis sets. with analysis entities
as Output (regarding to the update mechanism).
add(i_type: str) → AnalysisEntity

Note

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

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

Parameters:

iType
The type of the entity to create.

Returns:
The created analysis entity
Example:

This example create ThisAnalysisEntity in the AnalysisOutputEntities
collection

Dim AnalysisOutputEntities As
CATIAAnalysisOutputEntities
Dim ThisAnalysisEntity As AnalysisEntity
Set ThisAnalysisEntity = AnalysisOutputEntities.Add(“MyEntity”)
Parameters:

i_type (str) –

Return type:

AnalysisEntity

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 AnalysisEntity

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:

AnalysisEntity

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 entity
collection.

Parameters:

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

AnyObject.Name property.
Parameters:

i_index (cat_variant) –

Return type:

None