pycatia.abq_automation_interfaces.abq_rigid_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_rigid_coupling.ABQRigidCoupling(com_object)¶
Note
CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectABQAutomationItf.ABQInteractionABQRigidCouplingRepresents an Abaqus rigid coupling (ABQRigidCoupling) 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 isremoved from the coupling. If an attempt to remove the last support is made,the support is maintained and an error is returned.Parameters:iProductThe CATIA Product specifying the object to which the rigid couplingis applied.iPublicationThe CATIA Publication specifying the region to which the rigidcoupling is applied.Refer: CATIAPublication
- Parameters:
i_product (Product) –
i_publication (Publication) –
- 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)Adds a support to the coupling. If the support already exists, it isremoved from the coupling. If an attempt to remove the last support is made,the support is maintained and an error is returned.Parameters:iReferenceThe reference to the product as a CATIAReference.iSupportThe reference to the support as a CATIAReference.
- 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.Parameters:oProductsReturned safe array of products for the excluded region. This arrayhas a one-to-one mapping with the regions array.oRegionsReturned safe array of regions to exclude. This array has aone-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:oProductThe product for the handler.oRefThe reference to the handler.
- 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 thecoupling.Parameters:oProductThe CATIA Product specifying the local coordinate systempublication.oPubAxisSystemThe CATIA Axis system.Refer: CATIAAxisSystem
- Parameters:
o_product (Product) –
o_pub_axis_system (AxisSystem) –
- 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:oProductsReturned safe array of products for the supports. This array has aone-to-one mapping with the supports array.oSupportsReturned safe array of supports This array has a one-to-one mappingwith 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 AxisSystemSets or returns the local coordinate system. If nothing is passed in, itdefaults to the global coordinate system.
- Return type:
- 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)Returns 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)Returns 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 exclusionregions will be replaced with this new list. The list of excluded regions canbe cleared by passing in two empty lists for the products and the regions.Note: null values for products and regions are notaccepted.Parameters:iProductsSafe array of products for the excluded region. This array has aone-to-one mapping with the regions array.iRegionsSafe array of regions to exclude. This array has a one-to-onemapping 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 bereplaced with this new value.Parameters:iProductThe product for the handler.iRefThe reference to the handler.
- 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 bereplaced with this new value.Parameters:iProductThe CATIA Product for handeler.iPublicationThe CATIA Publication for handeler.Refer: CATIAPublication
- Parameters:
i_product (Product) –
i_publication (Publication) –
- 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 thepublication is not an axis system.Parameters:iProductThe CATIA Product specifying the local coordinate systempublication.iPublicationThe CATIA Publication on the axis system.Refer: CATIAPublication
- Parameters:
i_product (Product) –
i_pub_axis_system (Publication) –
- 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 supportregions will be replaced with this new list. At least one item in the list isrequired.Parameters:iProductsSafe array of products for the support region as CATIReferences.This array has a one-to-one mapping with the regions array.iRegionsSafe array of supports as CATIReferences. This array has aone-to-one mapping with the products array.
- Parameters:
i_products (tuple) –
i_regions (tuple) –
- Return type:
None
- property u1: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property U1() As booleanSets or returns the U1 degree of freedom.
- Return type:
bool
- property u2: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property U2() As booleanSets or returns the U2 degree of freedom.
- Return type:
bool
- property u3: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property U3() As booleanSets or returns the U3 degree of freedom.
- Return type:
bool
- property ur1: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property UR1() As booleanSets or returns 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 booleanSets or returns 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 booleanSets or returns the UR3 degree of freedom.
- Return type:
bool