All Frameworks  Object Hierarchy  This Framework  Indexes

Relations (Collection)

Represents the collection of relations of the part or the product.

A relation computes values. A relation can belong to one of the following types:

Formula

It combines parameters to compute the value of one output parameter only. For example, the mass of a cuboid can be the output parameter of a formula, while the value is computed using the following parameters:

 
 FormulaBody = (height*width*depth)*density

Program

It combines conditions and actions on parameters to compute one or several output parameter values. For example, the following is a program:

 ProgramBody = if (mass>2kg) { depth=2mm length=10mm } else { depth=1mm length=5mm }

Check

It only contains conditions on parameter values. For example, the following is a check:

 CheckBody = mass<10kg

The parameters should be defined previously.

The following example shows how to retrieve the collection of relations from a newly created part document:

 Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim part As Document
 Set part  = CATDocs.Add("CATPart")
 Dim relations As Relations
 Set relations = part.Relations

See also:: Formula, Rule, Check, DesignTable

Optimizations: Returns the optimization collection.

CreateCheck: Creates a check relation and adds it to the part's collection of relations.
CreateDesignTable: Creates a design table based on a file organized in an vertical way and adds it to the part's collection of relations.
CreateFormula: Creates a formula relation and adds it to the part's collection of relations.
CreateHorizontalDesignTable: Creates a design table based on a file organized in an horizontal way and adds it to the part's collection of relations.
CreateLaw: Creates a law relation and adds it to the part's collection of relations.
CreateProgram: Creates a program relation and adds it to the part's collection of relations.
CreateRuleBase: Creates a rulebase.
CreateSetOfEquations: Creates a set of equations.
CreateSetOfRelations: Creates a set of relations and appends it to a parent object.
GenerateXMLReportForChecks: Generates an XML Report on all checks in the current document.
Item: Retrieves a relation using its index or its name from the Relations collection.
Remove: Removes a relation from the Relations collection.
SubList: Returns a sub-collection of relations aggregated to an object.

Properties

o Property Optimizations(

) As (Read Only)

Returns the optimization collection.
It can be empty if no optimization is defined in the document.
This property is available only when the Product Engineering Optimizer license is available.

Methods

o Func CreateCheck(		`iName`,
		`iComment`,
		`iCheckBody`) As

Creates a check relation and adds it to the part's collection of relations.

Parameters:

iName: The check name
iComment: A description of the check
iCheckBody: The check definition

Returns:

The created check

Example:

This example creates the maximummass check relation and adds it to the newly created part:

 Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim partdoc As Document
 Set partdoc  = CATDocs.Add("CATPart")
 Dim part As Part
 Set part    = partdoc.Part 
 Dim massCheck As Check 
 Set massCheck    = part.Relations.CreateCheck
                    ("maximummass",
                     "Ensures that the mass is less than 10 kg",
                     "mass<10kg")

o Func CreateDesignTable(		`iName`,
		`iComment`,
		`iCopyMode`,
		`iSheetPath`) As

Creates a design table based on a file organized in an vertical way and adds it to the part's collection of relations.

Parameters:

iName: The design table name
iComment: A description of the design table
iCopyMode

Returns:

The created design table

Example:

This example creates the dt design table and adds it to the newly created part:

 Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim partdoc As Document
 Set partdoc  = CATDocs.Add("CATPart")
 Dim part As Part
 Set part    = partdoc.Part 
 Dim designtable As DesignTable
 Set designtable    = part.Relations.CreateDesignTable
                     ("dt",
                      "Ensures that the mass is less than 10 kg",
                      TRUE,
                      "/u/users/client/data/sheet.txt")

o Func CreateFormula(		`iName`,
		`iComment`,
		`iOutputParameter`,
		`iFormulaBody`) As

Creates a formula relation and adds it to the part's collection of relations.

Parameters:

iName: The formula name
iComment: A description of the formula
iOutputParameter: The parameter which stores the result of the formula
iFormulaBody: The formula definition

Returns:

The created formula

Example:

This example creates the computemass formula relation and adds it to the newly created part:

 Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim partdoc As Document
 Set partdoc  = CATDocs.Add("CATPart")
 Dim part As Part
 Set part    = partdoc.Part 
 Dim massFormula As Formula
 Set massFormula = part.Relations.CreateFormula
                   ("computemass",
                   "Computes the cuboid mass",
                    mass,
                   "(height*width*depth)*density")

o Func CreateHorizontalDesignTable(		`iName`,
		`iComment`,
		`iCopyMode`,
		`iSheetPath`) As

Creates a design table based on a file organized in an horizontal way and adds it to the part's collection of relations.

Parameters:

iName: The design table name
iComment: A description of the design table
iCopyMode

Returns:

The created design table

Example:

This example creates the dt design table and adds it to the newly created part:

 Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim partdoc As Document
 Set partdoc  = CATDocs.Add("CATPart")
 Dim part As Part
 Set part    = partdoc.Part 
 Dim designtable As DesignTable
 Set designtable    = part.Relations.CreateHorizontalDesignTable
                    ("dt",
                     "Ensures that the mass is less than 10 kg",
                     TRUE,
                     "/u/users/client/data/horizontalsheet.txt")

o Func CreateLaw(		`iName`,
		`iComment`,
		`iLawBody`) As

Creates a law relation and adds it to the part's collection of relations.

Parameters:

iName: The law name
iComment: A description of the law
iLawBody: The law definition

Returns:

The created law

o Func CreateProgram(		`iName`,
		`iComment`,
		`iProgramBody`) As

Creates a program relation and adds it to the part's collection of relations.

Parameters:

iName: The program name
iComment: A description of the program
iProgramBody: The program definition

Returns:

The created program

Example:

This example creates the selectdepth program relation and adds it to the newly created part:

 Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim partdoc As Document
 Set partdoc  = CATDocs.Add("CATPart")
 Dim part As Part
 Set part    = partdoc.Part 
 Dim depthProgram As Program
 Set depthProgram = part.Relations.CreateProgram
                    ("selectdepth",
                    "Select depth with respect to mass",
                    "if (mass>2kg) { depth=2mm } else { depth=1 mm }")

o Func CreateRuleBase( iName) As

Creates a rulebase.

Parameters:

iName: The name of the rulebase.

Returns:

The created rulebase.

See also:

ExpertRuleBase

o Func CreateSetOfEquations(		`iName`,
		`iComment`,
		`iFormulaBody`) As

Creates a set of equations.

Parameters:

iName: The name of the set of equation.
iComment: The comment of the set of equation.
iFormulaBody: The body of the set of equation " a==b+4; c ≤ 90".

Returns:

The created set of equations

o Sub CreateSetOfRelations( iParent)

Creates a set of relations and appends it to a parent object.

Parameters:

iParent: The object to which the set is appended

o Sub GenerateXMLReportForChecks( iName)

Generates an XML Report on all checks in the current document.

Parameters:

iName: The name of the XML file

o Func Item( iIndex) As

Retrieves a relation using its index or its name from the Relations collection.

Parameters:

o Sub Remove( iIndex)

Removes a relation from the Relations collection.

Parameters:

Example:

This example removes the relation named density from the relations collection.

 relations.Remove("density")

o Func SubList(		`iFeature`,
		`iRecursively`) As

Returns a sub-collection of relations aggregated to an object.

Parameters:

iFeature: The object used to filter the the whole relation collection to get the resulting sub-collection.
iRecursively: A flag to specify if children parameters are to be searched for in the returned collection

Returns:

The resulting sub-collection

Example:

This example shows how to get a collection of relations that are under a Pad

 Dim Relations1 As Relations
 Set Relations1 = CATIA.ActiveDocument.Part.Relations' gets the collection of relations in the part
 Dim Body0 As AnyObject
 Set Body0 = CATIA.ActiveDocument.Part.Bodies.Item  ( "MechanicalTool.1" ) 
 Dim Pad1 As AnyObject
 Set Pad1 = Body0.Shapes.Item  ( "Pad.1" ) ' gets the pad Pad.1
 Dim Relations2 As Relations
 Set Relations2 = Relations1.SubList(Pad1, TRUE) ' gets the collection of relations that are under the pad Pad.1

Relations (Collection)

Property Index

Method Index

Properties

Methods