pycatia.kinematics_interfaces.dressup

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.kinematics_interfaces.dressup.Dressup(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
Dressup

Interface to access the Dressup object.
attach(i_link: Product, i_attached_prod: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Attach(Product iLink,
Product iAttachedProd)

Attaches a given product to a link of the mechanism pointed by the
dressup.

Parameters:

iLink
The link (Product) on which the attachment should be done. It
should be a product that belongs to the mechanism pointed by the dressup,
otherwise the method will fail.
iAttachedProd
The Product that will be attached to the link. This product should
not be a product that is already attached by another link, otherwise the method
will fail.

Returns:
Nothing
Example:
This example attaches inside MyDressup, Link1 as mechanism’s part to
Product1.

Dim Link1 As Product
Dim Product1 As Product
…
MyDressup.Attach(Link1,Product1)
Parameters:
Return type:

None

property context: Product

Note

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

Returns the context product on which the mechanism is defined. This
property is read only.

Returns:
The dressup mechanism’s context
Example:
This example sets in MecaContext the context product of
MyDressup.

Dim MecaContext As Product
Set MecaContext = MyDressup.Context
Return type:

Product

detach(i_attached_prod: Product) → None

Note

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

Detaches an attached product from its link.

Parameters:

iAttachedProd
The Product that will be detached. It should be a product that is
currently attached in the dressup, otherwise the method will fail.


Returns:
Nothing
Example:
This example detaches Product1 previously attached to a mechanism’s
part inside MyDressup.

Dim Product1 As Product
…
MyDressup.Detach(Product1)
Parameters:

i_attached_prod (Product) –

Return type:

None

list_attached(i_link: Product) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListAttached(Product iLink) As CATSafeArrayVariant

Returns the list of products attached to a given link.

Parameters:

iLink
The Product on which the returned product list is attached to.


Returns:
The Product list that is attached to iLink.
Example:
The following example loops for all the products attached to
Link1.

Dim ListAttached1 as Product
ListAttached1 = MyDressup.ListAttached(Link1)
Dim Maxi as Integer
Set Maxi = ubound(ListAttached1)
Dim Prod_i as Product
For i = 0 To Maxi
Set Prod_i = ListAttached1(i)
..
Next
Parameters:

i_link (Product) –

Return type:

tuple

property mechanism: Mechanism

Note

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

Returns the mechanism on which a dressup is applied. This property is read
only.

Returns:
The dressup’s mechanism
Example:
This example sets in Meca the mechanism of MyDressup.

Dim Meca As Mechanism
Set Meca = MyDressup.Mechanism
Return type:

Mechanism