pycatia.abq_automation_interfaces.abq_rigid_body_constraint

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_body_constraint.ABQRigidBodyConstraint(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
ABQRigidBodyConstraint

Represents an Abaqus rigid body constraint (ABQRigidBodyConstraint)
object.
add_support_from_body(i_product: Product, i_body: Body) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromBody(Product iProduct,
Body iBody)

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

Parameters:

iProduct
The CATIAProduct specifying the positioning
object.
iBody
The CATIABody specifying the object that is being pointed
to.

Refer: CATIABody , CATIAProduct
Parameters:
Return type:

None

add_support_from_part(i_product: Product, i_part: Part) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromPart(Product iProduct,
Part iPart)

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

Parameters:

iProduct
The CATIAProduct specifying the positioning
object.
iSupport
The CATIAPart specifying the object that is being pointed
to.

Refer: CATIAPart , 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)

Adds a support to the Rigid body constraint. If the support already exists,
it is removed.

Parameters:

iProduct
The CATIA Product specifying the object to which the rigid body
constraint is applied.
iPublication
The CATIA Publication specifying the region to which the rigid body
constraint is applied.

Refer: CATIAPublication
Parameters:
Return type:

None

clear_pin_supports() → None

Note

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

Clears the pin point supports for the rigid body.
Return type:

None

clear_tie_supports() → None

Note

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

Clears the tie point supports for the rigid body.
Return type:

None

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

Note

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

Gets the pin point supports for the rigid body.

Parameters:

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

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

  • i_products (tuple) –

  • i_regions (tuple) –

Return type:

None

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

Note

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

Gets the tie point supports for the rigid body.

Parameters:

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

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

  • i_products (tuple) –

  • i_regions (tuple) –

Return type:

None

property move_to_center_of_mass: bool

Note

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

Sets or returns the move to center of mass flag.
Return type:

bool

property num_pin_supports: int

Note

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

Gets the number of pin point supports for the rigid body.
Return type:

int

property num_tie_supports: int

Note

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

Gets the number of tie point supports for the rigid body.
Return type:

int

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

Note

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

Set the handler for the rigid body.

Parameters:

iProduct
The CATIAProduct specifying the positioning
object.
iRef
The CATIAReference specifying the object that is being pointed
to.
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 Rigid body constraint. Any previously set handler
will be replaced with the new value.

Parameters:

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

Refer: CATIAPublication
Parameters:
Return type:

None

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

Note

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

Sets the pin point supports for the rigid body. Any previously set pin
supports 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 CATIReferences.
This array has a one-to-one mapping with the regions array.

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

  • i_products (tuple) –

  • i_regions (tuple) –

Return type:

None

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

Note

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

Sets the tie point supports for the rigid body. Any previously set tie
supports 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 CATIReferences.
This array has a one-to-one mapping with the regions array.

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

  • i_products (tuple) –

  • i_regions (tuple) –

Return type:

None