pycatia.product_structure_interfaces.products

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.product_structure_interfaces.products.Products(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Products

The collection of the Product objects contained in a given Product object of a

ProductDocument object.

A Product object can aggregate one or zero Products

collection.

add_component(i_reference_product: Product) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AddComponent(Product iReferenceProduct) As Product

Creates a component and adds it to the Products collection. A component is

a Product object created from another Product object used as

reference.

Parameters:

iReferenceProduct

The product used as reference

Example:

The following example creates the SpareWheel component

from

the reference product FrontRightWheel and adds the

component

to the ToolKits collection.

Dim SpareWheel As Product

Set SpareWheel = ToolKits.AddComponent(FrontRightWheel)

Parameters:

i_reference_product (Product) –

Return type:

Product

add_components_from_files(i_files_list: tuple, i_method: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddComponentsFromFiles(CATSafeArrayVariant iFilesList,

CATBSTR iMethod)

Creates a component for each file. The components are added to the Products

collection.

Parameters:

iFilesList

The paths of the files used to retrieve the reference or the shape

of th component

iMethod

A string describing the expected type of the files

Parameters:

• i_files_list (tuple) –

• i_method (str) –

Return type:

None

add_external_component(i_product_document: Document) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AddExternalComponent(Document iProductDocument) As

Product

Creates a component from the root product of another ProductDocument

object. This root product is used as a reference to create the component. The

component is added to the Products collection.

Parameters:

iProductDocument

The product document whose root object is to be used as reference

to create the component

Example:

The following example creates the GearBox component

by

referencing the GearBoxDocument and adds it

to the PowerTrains collection.

Dim GearBox As Product

Set GearBox = PowerTrains.AddExternalComponent(GearBoxDocument)

Parameters:

i_product_document (Document) –

Return type:

Product

add_new_component(i_documen_type: str, i_part_number: str) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AddNewComponent(CATBSTR iDocumenType,

CATBSTR iPartNumber) As Product

Creates a component from the root product of a new ProductDocument object.

This root product is used as a reference to create the component. The component

is added to the Products collection.

Parameters:

iProductDocument

The product document whose root object is to be used as reference

to create the component

Example:

The following example creates the GearBox component

by

referencing the GearBoxDocument and adds it

to the PowerTrains collection.

Dim GearBox As Product

Set GearBox = PowerTrains.AddNewComponent(GearBoxDocument, “A120-253X-7”)

Parameters:

• i_documen_type (str) –

• i_part_number (str) –

Returns:

Product

add_new_product(i_part_number: str) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AddNewProduct(CATBSTR iPartNumber) As Product

Creates a Product reference object. This creates a Product reference object

and the associated component by specifying its type and adds it to the Products

collection.

Parameters:

iPartNumber

The part number of the product to be created and added to the to

the collection

Example:

The following example creates the Engine product

and adds the created component to the PowerTrains

collection.

Dim Engine As Product

Set Engine = PowerTrains.AddNewProduct(V6Engine)

Parameters:

i_part_number (str) –

Return type:

Product

item(i_index: cat_variant) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As Product

Returns a product from its index in the Products

collection.

Parameters:

iIndex

The index of the product to retrieve in the collection of products.

This index can either be the rank of the product in the collection or the name

you assign to the product. As a numerics, this index is the rank of the product

in the collection. The index of the first product in the collection is 1, and

the index of the last product is Count. As a string, it is the name you

assigned to the product using the

AnyObject.Name property

Returns:

The retrieved product

Example:

The following example returns in ThisProduct the third

product,

and in ThatProduct the product named

Wheel in the CarParts product collection.

Dim ThisProduct As Product

Set ThisProduct = CarParts.Item(3)

Dim ThatProduct As Product

Set ThatProduct = CarParts.Item(“Wheel”)

Parameters:

i_index (cat_variant) –

Return type:

Product

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a product from the Products collection.

Parameters:

iIndex

The index of the product to remove. This index can either be the

rank of the product in the collection or the name you assigned to the product.

As a numerics, this index is the rank of the product in the collection. The

index of the first product in the collection is 1, and the index of the last

product is Count. As a string, it is the name you assigned to the product using

the

AnyObject.Name property

Example:

The following example removes the sixth product and the product

named

LeftRearDisc from the Brakes product collection.

Brakes.Remove(6)

Brakes.Remove(“LeftRearDisc”)

Parameters:

i_index (cat_variant) –

Return type:

None

replace_component(i_old_component: Product, i_file_path: str, i_multi_instances: bool) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ReplaceComponent(Product iOldComponent,

CATBSTR iFilePath,

boolean iMultiInstances) As Product

Creates a component which replace the given one.

Parameters:

iOldComponent

The component which will be replaced

iFilePath

the document to replace with

iMultiInstances

Parameter to set to True if all instances are to be replaced, or to

False otherwise. Returns the component replacing

iOldComponent

Note:

Part Number conflict will be resolved

automatically.

Parameters:

• i_old_component (Product) –

• i_file_path (str) –

• i_multi_instances (bool) –

Return type:

Product

replace_product(i_old_component: Product, i_new_reference: Product, i_multi_instances: bool) → Product

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ReplaceProduct(Product iOldComponent,

Product iNewReference,

boolean iMultiInstances) As Product

Creates a component which replace the given one.

Parameters:

iOldComponent

The component which will be replaced

iNewReference

the reference whom the old copmponent will be reconnected

iMultiInstances

Parameter to set to True if all instances are to be replaced, or to

False otherwise. Returns the component replacing

iOldComponent

Parameters:

• i_old_component (Product) –

• i_new_reference (Product) –

• i_multi_instances (bool) –

Return type:

Product