pycatia.analysis_interfaces.analysis_cases

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_cases.AnalysisCases(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

AnalysisCases

The collection of analysis case making an Analysis.

add() → AnalysisCase

Note

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

o Func Add() As AnalysisCase

Creates a new case and adds it to the case collection. This case will be

plugged under the analysis model.

Returns:

The created case

Example:

The following example creates a case NewCase in the case collection of

the ModelAnalysis Analysis model

.

Dim ModelAnalysis As AnalysisModel

Dim NewCase As AnalysisCase

Set NewCase = ModelAnalysis.AnalysisCases.Add()

Return type:

AnalysisCase

add_existing_case(i_case: AnalysisCase) → None

Note

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

o Sub AddExistingCase(AnalysisCase iCase)

Adds an existing analysis case to the analysis cases

collection.

Parameters:

iCase

The Existing Analysis Case.

Example:

This example adds ThisAnalysisCase in the analysisCases analysis

cases collection.

Dim ThisAnalysisCase As AnalysisCase

Dim analysisCases As AnalysisCases

…

analysisCases.AddExistingCase(ThisAnalysisCase)

Parameters:

i_case (AnalysisCase) –

Return type:

None

item(i_index: cat_variant) → AnalysisCase

Note

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

o Func Item(CATVariant iIndex) As AnalysisCase

Returns a case using its index or its name from the case

collection.

Parameters:

iIndex

The index or the name of the case to retrieve from the collection

of cases. As a numeric, this index is the rank of the case in the collection.

The index of the first case in the collection is 1, and the index of the last

case is Count. As a string, it is the name you assigned to the case using the

AnyObject.Name property.

Returns:

The retrieved case.

Example:

This example retrieves in ThisCase the fifth case in the collection and

in ThatCase the case named “MyCase in the case collection of the AnalysisModel

Analysis model.

Set CaseColl = AnalysisModel.AnalysisCases

Set ThisCase = CaseColl.Item(5)

Set ThatCase = CaseColl.Item(“MyCase”)

Parameters:

i_index (cat_variant) –

Return type:

AnalysisCase

new_case(i_type: str) → AnalysisCase

Note

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

o Func NewCase(CATBSTR iType) As AnalysisCase

Creates a new case and adds it to the case collection. This case will be

plugged under the analysis model.

Returns:

The created case

Example:

The following example creates a case NewCase in the case collection of

the ModelAnalysis Analysis model

.

Dim ModelAnalysis As AnalysisModel

Dim NewCase As AnalysisCase

Set NewCase = ModelAnalysis.AnalysisCases.NewCase(“AnalysisPreproCase”)()

Parameters:

i_type (str) –

Return type:

AnalysisCase

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 case using its index or its name from the case

collection.

Parameters:

iIndex

The index or the name of the case to retrieve from the collection

of cases. As a numeric, this index is the rank of the case in the collection.

The index of the first case in the collection is 1, and the index of the last

case is Count. As a string, it is the name you assigned to the case using the

AnyObject.Name property.

Example:

This example removes the fifth case in the collection.

AnalysisModel.AnalysisCases.Remove (5)

Parameters:

i_index (cat_variant) –

Return type:

None