pycatia.abq_automation_interfaces.abq_load

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_load.ABQLoad(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
ABQLoad

Represents the base interface for all load objects.
Role: The ABQLoad interface manages the common properties of any
load.
property activation_status: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ActivationStatus() As boolean

Sets or returns the activation status.

Returns:
A boolean specifying whether the pressure is activated.
Return type:

bool

add_support_from_product(i_product: Product, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromProduct(Product iProduct,
Reference iSupport)

Creates a new support and adds it to the description of the Analysis
Entity.

Parameters:

iProduct
The CATIA Product specifying the object to which the load is
applied.
iSupport
The CATIA Reference specifying the region to which the load is
applied.

Refer: CATIAReference , CATIAProduct
Parameters:
Return type:

None

add_support_from_publication(i_product: Product, i_publication: Publication) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromPublication(Product iProduct,
Publication iPublication)

Creates a new support and adds it to the description of the Analysis
Entity.

Parameters:

iProduct
The CATIA Product specifying the object to which the load is
applied.
iPublication
The CATIA Publication specifying the region to which the load is
applied.

Refer: CATIAPublication
Parameters:
Return type:

None

add_support_from_reference(i_reference: Reference, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromReference(Reference iReference,
Reference iSupport)

Creates a new support and adds it to the description of the Analysis
Entity.

Parameters:

iReference
The CATIA Reference specifying the object to which the load is
applied.
iSupport
The CATIA Reference specifying the region to which the load is
applied.

Refer: CATIAReference
Parameters:
Return type:

None

property amplitude: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Amplitude() As CATBSTR

Sets or returns the amplitude, given the name of the
amplitude.

Returns:
The amplitude object selected.
Return type:

str

property regions: AnalysisSupports

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Regions() As AnalysisSupports (Read Only)

Returns the region to which the load is applied.

Returns:
The region.
Return type:

AnalysisSupports

property smooth_amplitude: ABQSmoothStepAmplitude

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SmoothAmplitude() As ABQSmoothStepAmplitude

Sets or returns the Smooth Amplitude, given the refernce of the Smooth
amplitude.

Returns:
The amplitude object selected.
Return type:

ABQSmoothStepAmplitude

property status: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Status() As CATBSTR (Read Only)

Returns the propagating status of the load.

Returns:
The propagating status for example: if the load feature is created, it
will return “CREATED” if the load feature is propagated from previous step, it
will return “PROPAGATED”
Return type:

str

property tabular_amplitude: ABQTabularAmplitude

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TabularAmplitude() As ABQTabularAmplitude

Sets or returns the amplitude, given the Tabular amplitude
refrence.

Returns:
The amplitude object selected.
Return type:

ABQTabularAmplitude

property type: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Type() As CATBSTR (Read Only)

Returns the type of the load.

Returns:
The type of the load.
Return type:

str

property use_amplitude: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UseAmplitude() As boolean

Sets or returns a boolean indicating whether amplitude is used in a
load

Returns:
boolean specifying whether user defined amplitude is active.
Return type:

bool