=== enum_CatFileType_40640 ===
ProductStructureInterfaces CatFileTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatFileType (Enumeration)
enum CatFileType {
catFileTypeText,
catFileTypeMotif,
catFileTypeHTML
}
Possible types of Files.
Values:
catFileTypeText
Bill of material is recorded in Text File.
catFileTypeMotif
Bill of material is recorded in Motif File.
catFileTypeHTML
Bill of material is recorded in HTML File.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatProductSource_47634 ===
ProductStructureInterfaces CatProductSourceEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatProductSource (Enumeration)
enum CatProductSource {
catProductSourceUnknown,
catProductMade,
catProductBought
}
Possible types of product source.
Values:
catProductSourceUnknown
The product's origin is unknown
catProductMade
The product is made within the company
catProductBought
The product is bought from outside of the company
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatRepType_39656 ===
ProductStructureInterfaces CatRepTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatRepType (Enumeration)
enum CatRepType {
catRep3D,
catRep2D,
catRepText
}
Possible types of representations.
Values:
catRep3D
The representation is a 3D type
catRep2D
The representation is a 2D type
catRepText
The representation is a Text type
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatWorkModeType_45790 ===
ProductStructureInterfaces CatWorkModeTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatWorkModeType (Enumeration)
enum CatWorkModeType {
DEFAULT_MODE,
VISUALIZATION_MODE,
DESIGN_MODE
}
Possible types of Workmode.
Values:
DESIGN
The representation is in Design Mode
VISUALIZATION
The representation is in Visualization mode
DEFAULT
The representation is in Default Work mode.Default mode is a mode where the Product Container is loaded.
It's an intermediate mode between Visualization Mode and Design Mode.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Analyze_40312 ===
ProductStructureInterfaces Analyze (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Analyze (Object)
Represents the analysis object associated with a product.
Property Index
Mass
Returns the product mass value.
Volume
Returns the product volume value.
WetArea
Returns the product wet area (outer volume).
Method Index
GetGravityCenter
Returns the gravity center coordinates of product.
GetInertia
Returns the inertia matrix array of product.
Properties
Property Mass() As   (Read Only)
Returns the product mass value.
Example:
This example retrieves MassValue from
the Analyze object associated with myProduct:
MassValue = myProduct.Analyze.Mass
Property Volume() As   (Read Only)
Returns the product volume value.
Example:
This example retrieves VolumeValue from
the Analyze object associated with myProduct:
VolumeValue = myProduct.Analyze.Volume
Property WetArea() As   (Read Only)
Returns the product wet area (outer volume).
Note:
This method uses mm2 instead of default Catia V5 unit.
Example:
This example retrieves WetAreaValue from
the Analyze object associated with myProduct:
WetAreaValue = myProduct.Analyze.WetArea
Methods
Sub GetGravityCenter( oGravityCenterCoordinatesArray)
Returns the gravity center coordinates of product.
Parameters:
Coordinates
The array storing the three gravity center coordinates.
This array must be previously initialized.
Example:
This example retrieves the gravity center coordinates in
oGravityCenterCoordinatesArray from
the Analyze object associated with myProduct:
' Coordinates array initialization
Dim oGravityCenterCoordinatesArray ( 2 )
' Get value in array
Myproduct.Analyze.GetGravityCenter oGravityCenterCoordinatesArray
Sub GetInertia( oInertiaMatrixArray)
Returns the inertia matrix array of product.
Parameters:
oInertiaMatrixArray
The array storing successively the three columns of inertia matrix.
This array must be previously initialized.
Example:
This example retrieves the inertia matrix components in
oInertiaMatrixArray from
the Analyze object associated with myProduct:
' Components array initialization
Dim oInertiaMatrixArray ( 8 )
' Get value in array
Myproduct.Analyze.GetInertia oInertiaMatrixArray
' oInertiaMatrixArray ( 0 ) is the Ixx component
' oInertiaMatrixArray ( 1 ) is the Ixy component
' oInertiaMatrixArray ( 2 ) is the Ixz component
' oInertiaMatrixArray ( 3 ) is the Iyx component
' oInertiaMatrixArray ( 4 ) is the Iyy component
' oInertiaMatrixArray ( 5 ) is the Iyz component
' oInertiaMatrixArray ( 6 ) is the Izx component
' oInertiaMatrixArray ( 7 ) is the Izy component
' oInertiaMatrixArray ( 8 ) is the Izz component
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_AssemblyConvertor_52793 ===
ProductStructureInterfaces AssemblyConvertor (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
AssemblyConvertor (Object)
Product conversion object.
The AssemblyConvertor is the object that allows saving an assembly
to a specified format.
Two objects exist from now on : BillOfMaterial, which creates a bill of material
(every sub-assembly is represented, with all the one level depth components),
and ListingReport, which creates a listing report (shows the product
structure as it appears in the graph)
Method Index
Print
Extracts the product's contents as a specified format.
SetCurrentFormat
Defines the properties that will be used in the print method.
SetSecondaryFormat
Defines the secondary properties that will be used in the print method.
Methods
Sub Print( iFileType, iFile, iProduct)
Extracts the product's contents as a specified format.
Saves it in a txt, html or xls file (depends of the object).
Parameters:
iFileType
Type of the resulting file : TXT (for text file),
HTML (for html file), XLS (for xls file)
or MOTIF (do not use).
iFile
Path of the resulting file
iProduct
Product that will be converted
Sub SetCurrentFormat( ilistProps)
Defines the properties that will be used in the print method.
Parameters:
ilistProps
list of properties to display
Sub SetSecondaryFormat( ilistProps)
Defines the secondary properties that will be used in the print method.
Parameters:
ilistProps
secondary list of properties to display
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Product_40279 ===
ProductStructureInterfaces Product (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Product (Object)
Represents the product.
The product is the object that helps you model your real products
by building a tree structure whose nodes are product objects. Each
of them may contain other product objects gathered in a product
collection. The terminal product objects in the tree structure have
no aggregated product collection.
Even if all products are located somewhere in the product tree
structure, some of them can be used as reference products to create
other products named components, which are instances of the
reference product. For example, the left front wheel
in a car can be used as reference to create the other wheels.
Be careful: some properties and methods are dedicated to reference
objects only, and some others are for components only.
This is clearly stated for each property or method concerned.
Property Index
Analyze
Returns the Analyze object associated to the current product.
Definition
Returns or sets the product's definition.
DescriptionInst
Returns or sets the product's description for a component product.
DescriptionRef
Returns or sets the product's description for a reference product.
Move
Returns the product's move object.
Nomenclature
Returns or sets the product's nomenclature.
Parameters
Returns the collection object containing the product parameters.
PartNumber
Returns or sets the product's part number.
Position
Returns the product's position object.
Products
Returns the collection of products contained in the current product.
Publications
Returns the collection of publications managed by the product.
ReferenceProduct
Returns the Reference Product of this instance.
Relations
Returns the collection object containing the product relations.
Revision
Returns or sets the product's revision number.
Source
Returns or sets the product's source.
UserRefProperties
Returns the collection object containing the product properties.
Method Index
ActivateDefaultShape
Activate default shape.
ActivateShape
Activate one shape.
AddMasterShapeRepresentation
Adds the master shape representation to the product.
AddShapeRepresentation
Adds a representation to the product with a specific behavior.
ApplyWorkMode
Applies a new working mode.
Connections
Returns the product's constraints.
CreateReferenceFromName
Creates a reference from a name.
DesactivateDefaultShape
Deactivate default shape.
DesactivateShape
Deactivate one shape.
ExtractBOM
Extracts the product's contents as a bill of materials (BOM).
GetActiveShapeName
Returns the name of the active shape.
GetAllShapesNames
List the name of all shapes.
GetDefaultShapeName
Returns the default shape.
GetMasterShapeRepresentation
Retrieves the product's master shape representation.
GetMasterShapeRepresentationPathName
Retrieves the product's master shape representation pathname.
GetNumberOfShapes
Returns the number of Shapes
GetShapePathName
Returns the path name of a shape for a given shape name.
GetShapeRepresentation
Retrieves the product's  representation with the given parameters.
GetTechnologicalObject
Returns the product's applicative data which type is the given parameter.
HasAMasterShapeRepresentation
Returns whether the product has a master shape representation.
HasShapeRepresentation
Returns whether the product has a representation of the given name with a given behavior.
RemoveMasterShapeRepresentation
Removes the master shape representation from the product.
RemoveShapeRepresentation
Removes a specific representation from the product.
Update
Updates the product.
Properties
Property Analyze() As   (Read Only)
Returns the Analyze object associated to the current product.
Example:
This example retrieves in EngineAnalysis the Analyze object of
the Engine product.
Dim EngineAnalysis As Analyze
Set EngineAnalysis = Engine.Analyze
Property Definition() As
Returns or sets the product's definition.
Definition is valid for reference products only.
Example:
This example retrieves the definition of the
Engine product in EngineDef.
EngineDef = Engine.Definition
Property DescriptionInst() As
Returns or sets the product's description for a component product.
DescriptionInst is valid for component products only.
The description is a comment assigned to the component product to help
describe  or qualify it.
Example:
This example sets the description for the
EngineComp product.
Desc = "This is the Engine component product description"
EngineComp.DescriptionInst(Desc)
Property DescriptionRef() As
Returns or sets the product's description for a reference product.
DescriptionRef is valid for reference products only.
The description is a comment assigned to the reference product to help
describe  or qualify it.
Example:
This example sets the description for the
Engine product.
Desc = "This is the Engine reference product description"
Engine.DescriptionRef(Desc)
Property Move() As   (Read Only)
Returns the product's move object.
The move object is aggregated by the product object
and itself aggregates a movable object
to which you can apply a move transformation
by means of an isometry matrix. It moves your product
master shape representation according to this isometry.
Example:
This example retrieves the move object for the
Engine product.
Dim EngineMoveObject As Move
Set EngineMoveObject = Engine.Move
Property Nomenclature() As
Returns or sets the product's nomenclature.
Nomenclature is valid for reference products only.
According to the STEP AP203, the nomenclature is "a name by which
the part is commonly known within an organization".
Example:
This example retrieves the nomenclature the
Engine product in EngineNom.
EngineNom = Engine.Nomenclature
Property Parameters() As   (Read Only)
Returns the collection object containing the product parameters.
All the parameters that are aggregated in the different
objects of the product might be accessed through that collection.
Example:
The following example returns in params the parameters
of the productRoot product from the productDoc product document:
Set productRoot = productDoc.Product
Set params = productRoot.Parameters
Property PartNumber() As
Returns or sets the product's part number.
PartNumber is valid for reference products only.
Example:
This example sets the
Engine product's part number to A120-253X-7.
Engine.PartNumber("A120-253X-7")
Property Position() As   (Read Only)
Returns the product's position object.
The position object is the object aggregated by the product object that
holds the position of the master shape representation in the space.
Example:
This example retrieves the position object for the
Engine product.
Dim EnginePositionObject As Position
Set EnginePositionObject = Engine.Position
Property Products() As   (Read Only)
Returns the collection of products contained in the current product.
Example:
This example retrieves in EngineChildren the collection of
products contained in the Engine product.
Dim EngineChildren As Products
Set EngineChildren = Engine.Products
Property Publications() As   (Read Only)
Returns the collection of publications managed by the product.
Property ReferenceProduct() As   (Read Only)
Returns the Reference Product of this instance.
Property Relations() As   (Read Only)
Returns the collection object containing the product relations.
All the relations that are used to valuate
the parameters of the product might be accessed thru that collection.
Example:
The following example returns in rels the relations
of the productRoot product from the productDoc product document:
Set productRoot = productDoc.Product
Set rels = productRoot.Relations
Property Revision() As
Returns or sets the product's revision number.
Revision is valid for reference products only.
Example:
This example sets the
Engine product's revision number to 3A.
Engine.Revision("3A")
Property Source() As
Returns or sets the product's source.
Source is valid for reference products only.
According to the STEP AP203, the source is the "design organization's
plan for obtaining the product".
The source can take the values catProductMade if the product is made
internally, catProductBought if it is purchased from a vendor,
or catProductUnknown if its origin is not determined.
Example:
This example sets the source for the
Engine product to catProductMade.
Engine.Source(catProductMade)
Property UserRefProperties() As   (Read Only)
Returns the collection object containing the product properties.
All the user defined properties that are created in the reference product
might be accessed through that collection.
Only available on reference products.
Example:
The following example returns in UserProps the properties
of the productRoot product from the productDoc product document:
Set productRoot = productDoc.Product
Set UserProps = productRoot.UserRefProperties
Methods
Sub ActivateDefaultShape()
Activate default shape.
Sub ActivateShape( ShapeName)
Activate one shape.
Parameters:
ShapeName
The name of the shape.
Sub AddMasterShapeRepresentation( iShapePathName)
Adds the master shape representation to the product.
The master shape representation is the object that gives a geometric
shape and allows
the visualization of the product. It can be
a CATIA V4
model, a VRML file, or any other type of document that can be displayed.
In a multi representation  context, the master shape representation is the most
meaningful representation of the product according to the user.
This is the default shape for the multi representation.
Note:
This master shape representation is optional.
Parameters:
iShapePathName
The path name where the master shape representation can be found
Example:
This example adds the e:\Models\Engine.model as
the master shape representation to the Engine product.
Engine.AddMasterShapeRepresentation("e:\Models\Engine.model")
Sub AddShapeRepresentation( iShapePathName, iShapeName, iRepBehavior, iContext)
Adds a representation to the product with a specific behavior.
A representation is the object that gives a geometric shape and allows
the visualization of the product. It can be
a CATIA V4
model, a VRML file, or any other type of document that can be displayed.
Note:
The possible behavior supported are : 3D, 2D and text.
The representation can also be added within a context or not.
A representation on a product is optional, but many representation with
different behavior (or the same) is supported
Parameters:
iShapePathName
The path name where the representation can be found
iShapeName
The name that is given to the representation
This name is a user free choice
iRepBehavior
The behavior of the added representation.
It can take the values catRep3D if the representation is a 3D one,
catRep2D if the representation is a 2D one,
or catRepText if the representation is a text one.
iContext
A condition to specify if the added representation can be
displayed with the representation of other products.
Example:
This example adds the e:\Models\Engine.model as
a 3D representation to the Engine product within an assembly context.
Engine.AddShapeRepresentation("e:\Models\Engine.model","MyShape",catRep3D,TRUE)
Sub ApplyWorkMode( newMode)
Applies a new working mode.
Parameters:
newMode
The new working mode.
Func Connections( iConnectionsType) As
Returns the product's constraints.
The constraint collection of a product gathers the constraints
this product should respect to be positioned in the space.
Example:
This example retrieves the constraint collection for the
Engine product.
Dim EngineConstraints As Collection
Set EngineConstraints = Engine.Constraints
Func CreateReferenceFromName( iLabel) As
Creates a reference from a name.
A reference is an object that can stand for any geometrical object.
Creating references is necessary for adding constraints between two
components using Brep elements of the representations of these
components.
Parameters:
iLabel
The path of the Brep element to use in the constraint.
This path is passed as a character string comprising the component
path from the root product to the component concerned, concatenated
to the Brep element path in the product's representation.
Components are separated using "/", and the product path is separated
from the Brep using "/!". For separating parameter from product path use "\".
Returns:
The created reference
Example:
This example creates a reference from the path of a Brep element
in the Prod2 product located below the Root root
product. The face is located in the Pad.1 pad and limited by the
Circle.1 circle.
Dim Ref As Reference
Ref = Prod2.CreateReferenceFromName("Root/Prod2/!Face:(Brp:(Pad.1:0(Brp:(Circle.1))):None())")
Sub DesactivateDefaultShape()
Deactivate default shape.
Sub DesactivateShape( ShapeName)
Deactivate one shape.
Parameters:
ShapeName
The name of the shape.
Sub ExtractBOM( iFileType, iFile)
Extracts the product's contents as a bill of materials (BOM).
The bill of material displays, for every sub-assembly in the product,
the one level depth components and some of their properties.
Parameters:
iFileType
Set this parameter to catFileTypeHTML to save to the html format.
Set this parameter to catFileTypeTXT to save to the text format.
The catFileTypeMotif should not be used.
iFile
File where the bill of material will be saved
Func GetActiveShapeName() As
Returns the name of the active shape.
Returns:
oShapeName           The name of the active shape.
Sub GetAllShapesNames( olistshape)
List the name of all shapes.
Returns:
olistshape           The list of the names
The tab olistshape has to be allocated with a size given by GetNumberOfShapes.
Func GetDefaultShapeName() As
Returns the default shape.
Returns:
oShapeName           The name of the default shape.
Func GetMasterShapeRepresentation( iLoadIfNecessary) As
Retrieves the product's master shape representation.
Parameters:
iLoadIfNecessary
Parameter to set to True if the master shape representation
should be loaded to determine if it exists, or to False otherwise.
Example:
This example retrieves in MSRep the
Engine product's master shape representation.
Dim MSRep As Object
Set MSRep = Engine.GetMasterShapeRepresentation(True)
Func GetMasterShapeRepresentationPathName() As
Retrieves the product's master shape representation pathname.
Example:
This example retrieves in MSRep the
Engine product's master shape representation.
Set MSRepPath = Engine.GetMasterShapeRepresentationPathName
Func GetNumberOfShapes() As
Returns the number of Shapes
Returns:
oNbShapes           The number of Shapes.
Func GetShapePathName( iShapeName) As
Returns the path name of a shape for a given shape name.
Parameters:
iShapeName
The name of the shape.
Returns:
oShapePathName           The path name of the shape.
Func GetShapeRepresentation( iLoadIfNecessary, iShapeName, iRepBehavior, iContext) As
Retrieves the product's  representation with the given parameters.
Parameters:
iLoadIfNecessary
Parameter to set to True if the master shape representation
should be loaded to determine if it exists, or to False otherwise.
iShapeName
The name of the representation of the product.
iRepBehavior
The behavior of the representation.
It can take the values catRep3D if the representation is a 3D one,
catRep2D if the representation is a 2D one,
or catRepText if the representation is a text one.
iContext
A condition to specify if the representation is
displayed with the representation of other products.
Example:
This example retrieves in MSRep the
Engine product's  3D representation named "PART".
Dim MSRep As Object
Set MSRep = Engine.GetMasterShapeRepresentation(True,"PART",catRep3D,TRUE)
Func GetTechnologicalObject( iApplicationType) As
Returns the product's applicative data which type is the given parameter.
The data returned can be either a collection or a simple object.
Parameters:
iApplicationType
The type of applicative data searched.
Example:
This example retrieves the constraints for the
Engine product.
Dim EngineConstraints As Collection
Set EngineConstraints = Engine.GetTechnologicalObject("Constraints")
Func HasAMasterShapeRepresentation() As
Returns whether the product has a master shape representation.
True if the product has a master shape representation.
Example:
This example retrieves in HasMSRep whether the
Engine product has a master shape representation.
HasMSRep = Engine.HasAMasterShapeRepresentation()
Func HasShapeRepresentation( iShapeName, iRepBehavior, iContext) As
Returns whether the product has a representation of the given name with a given behavior.
True if the product has such a representation.
Parameters:
iShapeName
The name of the representation of the product.
iRepBehavior
The behavior of the representation.
It can take the values catRep3D if the representation is a 3D one,
catRep2D if the representation is a 2D one,
or catRepText if the representation is a text one.
iContext
A condition to specify if the representation is
displayed with the representation of other products.
Example:
This example retrieves in HasRep whether the
Engine product has a master shape representation.
HasRep = Engine.HasRepresentation("PART",catRep3D,TRUE)
Sub RemoveMasterShapeRepresentation()
Removes the master shape representation from the product.
The master shape representation is the object that gives a geometric
shape and allows
the visualization of the product. It can be
a CATIA V4
model, a VRML file, or any other type of document that can be displayed.
In a multi representation  context, the master shape representation is the most
meaningful representation of the product according to the user.
This is the default shape for the multi representation.
Note:
This master shape representation is optional.
Example:
This example removes the master shape representation of the
Engine product.
Engine.RemoveMasterShapeRepresentation()
Sub RemoveShapeRepresentation( iShapeName, iRepBehavior, iContext)
Removes a specific representation from the product.
A representation is the object that gives a geometric shape and allows
the visualization of the product.. It can be
a CATIA V4
model, a VRML file, or any other type of document that can be displayed.
Note:
This representation is optional.
Parameters:
iShapeName
The name of the representation of the product.
iRepBehavior
The behavior of the representation.
It can take the values catRep3D if the representation is a 3D one,
catRep2D if the representation is a 2D one,
or catRepText if the representation is a text one.
iContext
A condition to specify if the representation is
displayed with the representation of other products.
Example:
This example removes the 3D representation named "PART" of the
Engine product.
Engine.RemoveMasterShapeRepresentation
("PART",catRep3D,TRUE)
Sub Update()
Updates the product.
This update is performed with respect to the part making the product
or to the product's representation. It takes into account the
components of the product at any level
Example:
The following example updates the root product:
Dim RootProduct As Product
Set Rootproduct = productDoc.Product
Rootproduct.Update
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_ProductDocument_49169 ===
ProductStructureInterfaces ProductDocument (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
ProductDocument (Object)
Represents the Document object for product structures.
When a ProductDocument is created, a root product is created
whose parent is the ProductDocument object. Its default name
is RootProduct, which can be overwritten thanks to the
the  property. This root product is at the top of the product tree structure contained
in the document. It has no difference with the other contained products,
except it has no father product in the product tree structure within
the document.
Property Index
Product
Returns the root product.
Properties
Property Product() As   (Read Only)
Returns the root product.
Example:
This example retrieves the root product of the MyProductDoc
ProductDocument in RootProduct.
Dim RootProduct As Product
Set RootProduct = MyProductDoc.Product
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Products_41084 ===
ProductStructureInterfaces Products (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Products (Object)
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.
Method Index
AddComponent
Creates a component and adds it to the Products collection.
AddComponentsFromFiles
Creates a component for each file.
AddExternalComponent
Creates a component from the root product of
another ProductDocument object.
AddNewComponent
Creates a component from the root product of
a new ProductDocument object.
AddNewProduct
Creates a Product reference object.
Item
Returns a product from its index in the Products collection.
Remove
Removes a product from the Products collection.
ReplaceComponent
Creates a component which replace the given one.
ReplaceProduct
Creates a component which replace the given one.
Methods
Func AddComponent( iReferenceProduct) As
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)
Sub AddComponentsFromFiles( iFilesList, 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
Func AddExternalComponent( iProductDocument) As
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)
Func AddNewComponent( iDocumenType, iPartNumber) As
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")
Func AddNewProduct( iPartNumber) As
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)
Func Item( iIndex) As
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
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")
Sub Remove( 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
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")
Func ReplaceComponent( iOldComponent, iFilePath, iMultiInstances) As
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.
Func ReplaceProduct( iOldComponent, iNewReference, iMultiInstances) As
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
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Publication_43869 ===
ProductStructureInterfaces Publication (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Publication (Object)
The interface to access a CATIAPublication.
Property Index
Relay
Valuates a publication object with another publication object.
Valuation
Returns published object.
Properties
Property Relay( iPub) (Write Only)
Valuates a publication object with another publication object.
Role:  This method allows to valuate a publication with an intermediate one.
Parameters:
iPub
The intermediate publication object
Example:
The following example valuates the publication object Pub1
with the publication object Pub2
Pub1.Relay(Pub2)
Property Valuation() As
Returns published object.
Role:  This method gives access to the finally published object.
Parameters:
oRef
The final reference of the publication object.
Example:
This example returns the final reference Ref
of the publication object Pub1.
Dim Ref As Reference
Ref = Pub1.Valuation
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Publications_45134 ===
ProductStructureInterfaces Publications (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Publications (Object)
The collection of the Product publications.
A Product object can aggregate one or zero Publications collection.
Method Index
Add
Adds a publication object to the product and returns a pointer to the
publication object.
Item
Returns the publication object corresponding to the given publication name.
Remove
Removes a publication from the product.
SetDirect
Valuates a publication object directly with the object it publishes.
SetRelay
Valuates a publication object with another publication object.
Methods
Func Add( iPublicName) As
Adds a publication object to the product and returns a pointer to the
publication object.
Parameters:
iPublicName
The name of the publication
oPub
The publication object
Example:
The following example adds a new publication object with the name "PubName"
to the product and returns the publication object Pub1.
Dim Prod1 As Product
Set Pub1 = Prod1.Add(PubName)
Func Item( iIdentifier) As
Returns the publication object corresponding to the given publication name.
Parameters:
iIdentifier
The name of the publication
oPub
The publication object
Example:
The following example returns Pub1 publication object from
the product referencing the published name PubId.
Dim Prod1 As Product
Set Pub1 = Prod1.Item(PubId)
Sub Remove( iIdentifier)
Removes a publication from the product.
Parameters:
iIdentifier
The name of the publication
Example:
The following example removes the publication object corresponding to the name
PubId.
Dim Prod1 As Product
Prod1.Remove(PubId)
Sub SetDirect( iIdentifier, iPointed)
Valuates a publication object directly with the object it publishes.
Parameters:
iIdentifier
The name of the publication
iPointed
The published object
The following
objects is supported:
Example:
The following example valuates the publication object of product Prod1
having the name PubId with the reference object RefObject.
Dim Prod1 As Product
Prod1.SetDirect(PubId,RefObject)
Sub SetRelay( iIdentifier, iRelayer, iNameInRelay)
Valuates a publication object with another publication object.
Parameters:
iIdentifier
The name of the publication to be valuated
iRelayer
The product aggregating the valuating intermediate publication object
iNameInRelay
The name of the valuating publication object
Example:
The following example valuates the publication object of product Prod1
having the name PubId1 with the publication object of product Prod2
having the name PubId2.
Dim Prod1 As Product
Prod1.SetRelay(PubId1,Prod2,PubId2)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.