pycatia.abq_automation_interfaces.abq_steps

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.abq_automation_interfaces.abq_steps.ABQSteps(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
ABQSteps

The collection of Abaqus analysis step (ABQStep) objects contained in
an
ABQAnalysisCase object.
add(i_step_type: str) → ABQStep

Note

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

Creates a new Abaqus Step and adds it to the collection of Abaqus
steps.

Parameters:

iStepType
The type of the step to create.

Legal values: “ABQGeneralStaticStep”, “ABQFrequencyStep”,
“ABQExplicitDynamicsStep”, “ABQHeatTransferStep” “ABQLinearDynamicStepModal”
“ABQLinearDynamicStepSubspace”

Returns:
oStep The Abaqus step object that was created.
Example:
The following example creates a general static step in the ABQSteps
collection:

Dim abqCase As ABQAnalysisCase
Dim abaqusSteps As ABQSteps
Dim generalstaticstep As ABQGeneralStaticStep
Set abaqusSteps = abqCase.Steps
Set generalstaticstep = abaqusSteps.Add(“ABQGeneralStaticStep”)
Parameters:

i_step_type (str) –

Return type:

ABQStep

insert(i_step_type: str, i_index: cat_variant) → ABQStep

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Insert(CATBSTR iStepType,
CATVariant iIndex) As ABQStep

Creates a new Abaqus Step and inserts it to the collection of Abaqus
steps.

Parameters:

iStepType
The type of the step to create.

Legal values: “ABQGeneralStaticStep”, “ABQFrequencyStep”,
“ABQExplicitDynamicsStep”, “ABQHeatTransferStep”
iIndex
Index of Abaqus step after which the new step is to be inserted.
for initialization step iIndex is 1

Returns:
oStep The Abaqus step object that was inserted.
Example:
The following example creates a general static step in the ABQSteps
collection:

Dim abqCase As ABQAnalysisCase
Dim abaqusSteps As ABQSteps
Dim generalstaticstep As ABQGeneralStaticStep
Set abaqusSteps = abqCase.Steps
Set generalstaticstep = abaqusSteps.Insert(“ABQGeneralStaticStep”, 1)
Parameters:

  • i_step_type (str) –

  • i_index (cat_variant) –

Return type:

ABQStep

item(i_index: cat_variant) → ABQStep

Note

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

Returns an Abaqus step using its index or its name from the ABQSteps
collection.

Parameters:

iIndex
The index or the name of the Abaqus step to retrieve from the
collection of Abaqus steps. If the index is a number, it specifies the rank of
the Abaqus step in the collection. The index of the first Abaqus step in the
collection is 1, and the index of the last step is Count. If the index is a
string, it specifies the name you assigned to the step using the
CATIACollection::Name property.

Returns:
The specified ABQStep.
Example:
This example retrieves the fifth Abaqus step in the collection and
saves it in a variable called FirstStep. The example also retrieves the Abaqus
step named “MyStep” in the collection and saves it in a variable called
SecondStep.

Set CaseColl = AnalysisDoc.ABQAnalysisModel.Cases
Set ThisCase = CaseColl.Item(5)
Set StepColl = ThisCase.Steps
Set FirstStaticStep = StepColl.Item(5)
Set SecondStaticStep = StepColl.Item(“MyStep”)
Parameters:

i_index (cat_variant) –

Return type:

ABQStep

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 an Abaqus step using its index or its name from the Step
collection.

Parameters:

iIndex
The index or the name of the Abaqus step to retrieve from the
collection of Abaqus Steps. If the index is a number, it specifies the rank of
the Abaqus step in the collection. The index of the first Abaqus step in the
collection is 1, and the index of the last step is Count. If the index is a
string, it specifies the name you assigned to the step using the
CATIABase::Name property.
Parameters:

i_index (cat_variant) –

Return type:

None