pycatia.mec_mod_interfaces.fix_together

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.mec_mod_interfaces.fix_together.FixTogether(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

FixTogether

The object that manages a sequence of products or

fixTogethers.

It belongs to the FixTogether collection of a Product.

add_fix_together(i_fix_together: FixTogether) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddFixTogether(FixTogether iFixTogether)

Add a fixTogether to a FixTogether. The fixTogether is fixed together with

the products or fixTogethers already contained in the FixTogether.

Example:

The following example adds a FixTogether fixTogether in a FixTogether

myFixTogether.

myFixTogether.AddFixTogether(fixTogether)

Parameters:

i_fix_together (FixTogether) –

Return type:

None

add_product(i_product: Product) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddProduct(Product iProduct)

Add a product to a FixTogether. The product is fixed together with the

products and fixTogethers already contained in the FixTogether.

Example:

The following example adds a Product myProduct in a

FixTogether.

myFixTogether.AddProduct(myProduct)

Parameters:

i_product (Product) –

Return type:

None

property fix_togethers_count: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FixTogethersCount() As long (Read Only)

Returns the number of FixTogether entities in the

FixTogether.

Example:

The following example retrieves in fixTogethersCount the number of

FixTogethers of the myFixTogether FixTogether :

fixTogethersCount = myFixTogether.FixTogethersCount

Return type:

int

get_fix_together(i_index: cat_variant) → FixTogether

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetFixTogether(CATVariant iIndex) As FixTogether

Returns a FixTogether using its index or its name in the

FixTogether.

Parameters:

iIndex

The index or the name of the FixTogether to retrieve. As a

numerics, this index is the rank of the FixTogether in the FixTogethers of the

FixTogether. The index of the first FixTogether is 1, and the index of the last

FixTogether is FixTogether sCount. As a string, it is the name you assigned to

the FixTogether using the

AnyObject.Name property.

Returns:

The retrieved FixTogether

Example:

This example retrieves in thisFixTogether the fifth FixTogether and in

thatFixTogether the FixTogether named myFixTogether in the FixTogethers of the

FixTogether.

Dim thisFixTogether As FixTogether

Set thisFixTogether = myFixTogether.GetFixTogether(5)

Dim thatFixTogether As FixTogether

Set thatFixTogether = myFixTogether.GetFixTogether(“myFixTogether”)

Parameters:

i_index (cat_variant) –

Return type:

FixTogether

get_product(i_index: cat_variant) → Product

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetProduct(CATVariant iIndex) As Product

Returns a Product using its index or its name in the

FixTogether.

Parameters:

iIndex

The index or the name of the Product to retrieve. As a numerics,

this index is the rank of the Product in the products of the FixTogether. The

index of the first Product is 1, and the index of the last Product is

ProductsCount. As a string, it is the name you assigned to the Product using

the

AnyObject.Name property.

Returns:

The retrieved Product

Example:

This example retrieves in thisProduct the fifth Product and in

thatProduct the Product named myProduct in the products of the

FixTogether.

Dim thisProduct As Product

Set thisProduct = myFixTogether.GetProduct(5)

Dim thatProduct As Product

Set thatProduct = myFixTogether.GetProduct(“myProduct”)

Parameters:

i_index (cat_variant) –

Return type:

Product

property products_count: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ProductsCount() As long (Read Only)

Returns the number of products fixed together in the

FixTogether.

Example:

The following example retrieves in productsCount the number of products

of the myFixTogether FixTogether :

productsCount = myFixTogether.ProductsCount

Return type:

int

remove_fix_together(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveFixTogether(CATVariant iIndex)

Removes a FixTogether from the FixTogether.

Parameters:

iIndex

The index or the name of the FixTogether to remove from the

FixTogether. As a numerics, this index is the rank of the FixTogether in the

FixTogethers of the FixTogether. The index of the first FixTogether is 1, and

the index of the last FixTogether is FixTogethersCount. As a string, it is the

name you assigned to the FixTogether using the

AnyObject.Name property.

Example:

This example removes the last FixTogether of the

FixTogether.

fixTogether.RemoveFixTogether(fixTogether.FixTogethersCount)

Parameters:

i_index (cat_variant) –

Return type:

None

remove_product(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveProduct(CATVariant iIndex)

Removes a Product from the FixTogether.

Parameters:

iIndex

The index or the name of the Product to remove from the

FixTogether. As a numerics, this index is the rank of the Product in the

products of the FixTogether. The index of the first Product is 1, and the index

of the last Product is ProductsCount. As a string, it is the name you assigned

to the FixTogether using the

AnyObject.Name property.

Example:

This example removes the last Product of the FixTogether.

fixTogether.RemoveProduct(fixTogether.ProductsCount)

Parameters:

i_index (cat_variant) –

Return type:

None