pycatia.abq_automation_interfaces.abq_smooth_coupling

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_smooth_coupling.ABQSmoothCoupling(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
ABQAutomationItf.ABQInteraction
ABQSmoothCoupling

Represents an Abaqus smooth coupling (ABQSmoothCoupling)
object.
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)

Adds a support to the coupling. If the support already exists, it is
removed from the coupling. If an attempt to remove the last support is made,
the support is maintained and an error is returned.

Parameters:

iProduct
The CATIA Product specifying the object to which the smooth
coupling is applied.
iPublication
The CATIA Publication specifying the region to which the smooth
coupling 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)

AddSupportFromReference - adds a support to the coupling. If the support
already exists, it is removed from the coupling. If an attempt to remove the
last support is made, the support is maintained and an error is
returned.

Parameters:

iReference
The reference to the product as a CATIAReference.
iSupport
The reference to the support as a CATIAReference.
Parameters:
Return type:

None

clear_exclusion_regions() → None

Note

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

Clears the exclusion regions list.
Return type:

None

clear_handler() → None

Note

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

Clears the handler.
Return type:

None

get_exclusion_regions(o_products: tuple, o_regions: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetExclusionRegions(CATSafeArrayVariant oProducts,
CATSafeArrayVariant oRegions)

Returns the exclusion regions for the coupling. param oProducts Returned
safe array of products for the excluded region, as CATIAReferences. This array
has a one-to-one mapping with the regions array.

Parameters:

oRegions
Returned safe array of regions to exclude, as CATIAReferences. This
array has a one-to-one mapping with the products
array.
Parameters:

  • o_products (tuple) –

  • o_regions (tuple) –

Return type:

None

get_handler(o_product: Reference, o_ref: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetHandler(Reference oProduct,
Reference oRef)

Returns the handler for the coupling.

Parameters:

oProduct
The product for the handler.
oRef
The reference to the handler.
Parameters:
Return type:

None

get_local_csys_from_publication(o_product: Product, o_pub_axis_system: AxisSystem) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetLocalCsysFromPublication(Product oProduct,
AxisSystem oPubAxisSystem)

Gets the published local coordinate system of for the
coupling.

Parameters:

oProduct
The CATIA Product specifying the local coordinate system
publication.
oPubAxisSystem
The CATIA Axis system.

Refer: CATIAAxisSystem
Parameters:
Return type:

None

get_supports(o_products: tuple, o_supports: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetSupports(CATSafeArrayVariant oProducts,
CATSafeArrayVariant oSupports)

Returns the supports for the coupling.

Parameters:

oProducts
Returned safe array of products for the supports, as
CATIAReferences. This array has a one-to-one mapping with the supports array.

oSupports
Returned safe array of supports, as CATIAReferences. This array has
a one-to-one mapping with the products array.
Parameters:

  • o_products (tuple) –

  • o_supports (tuple) –

Return type:

None

property local_csys: AxisSystem

Note

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

Returns or sets the local coordinate system. If nothing is passed in then
it defaults to the global coordinate system.
Return type:

AxisSystem

property num_exclusion_regions: int

Note

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

Retrieves the number of currently active exclusion regions.
Return type:

int

property num_supports: int

Note

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

Retrieves the number of supports.
Return type:

int

set_exclusion_regions(i_products: tuple, i_regions: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetExclusionRegions(CATSafeArrayVariant iProducts,
CATSafeArrayVariant iRegions)

Sets the exclusion regions for the coupling. Any previously set exclusion
regions will be replaced with this new list. The list of excluded regions can
be cleared by passing in two empty lists for the products and the regions.
Note: null values for products and regions are not
accepted.

Parameters:

iProducts
Safe array of products for the excluded region, as CATIAReferences.
This array has a one-to-one mapping with the regions array.

iRegions
Safe array of regions to exclude, as CATIAReferences. This array
has a one-to-one mapping with the products array.
Parameters:

  • i_products (tuple) –

  • i_regions (tuple) –

Return type:

None

set_handler(i_product: Reference, i_ref: Reference) → None

Note

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

Sets the handler for the coupling. Any previously set handler will be
replaced with this new value.

Parameters:

iProduct
The product for the handler.
iRef
The reference to the handler.
Parameters:
Return type:

None

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

Note

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

Sets the handler for the coupling. Any previously set handler will be
replaced with this new value.

Parameters:

iProduct
The CATIA Product for handeler.
iPublication
The CATIA Publication for handeler.

Refer: CATIAPublication
Parameters:
Return type:

None

set_local_csys_from_publication(i_product: Product, i_pub_axis_system: Publication) → None

Note

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

Sets the published local coordinate system for the coupling. Fails if the
publication is not an axis system.

Parameters:

iProduct
The CATIA Product specifying the local coordinate system
publication.
iPublication
The CATIA Publication on the axis system.

Refer: CATIAPublication
Parameters:
Return type:

None

set_supports(i_products: tuple, i_regions: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSupports(CATSafeArrayVariant iProducts,
CATSafeArrayVariant iRegions)

Sets the support regions for the coupling. Any previously set support
regions will be replaced with this new list. At least one item in the list is
required.

Parameters:

iProducts
Safe array of products for the support region as CATIAReferences.
This array has a one-to-one mapping with the regions array.

iRegions
Safe array of supports as CATIAReferences. This array has a
one-to-one mapping with the products array.
Parameters:

  • i_products (tuple) –

  • i_regions (tuple) –

Return type:

None

property ur1: bool

Note

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

Returns or sets the UR1 degree of freedom.
Return type:

bool

property ur2: bool

Note

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

Returns or sets the UR2 degree of freedom.
Return type:

bool

property ur3: bool

Note

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

Returns or sets the UR3 degree of freedom.
Return type:

bool