knowledge_interfaces¶

Note

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

o Property Value() As boolean

Returns or sets the value of the boolean parameter.

Example:

This example sets the availability boolean parameter value to True if

its value is False:

If (availability.Value = False) Then

availability.Value = True

End If

Note

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

o Property Diagnosis() As boolean (Read Only)

Returns the check diagnosis. True if the condition of the check is

verified. False otherwise.

Note

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

o Property Severity() As long

Returns or sets the check severity. The severity is the way the check will

manifest itself:

Silent (1)

Information (2)

Warning (3)

Note

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

o Sub Solve()

Solves the constraint satisfaction problem.

Note

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

o Sub AddAssociation(Parameter iParameter,

CATBSTR iSheetColumn)

Adds an association between a parameter iParameter and a column of the

design table. This method does nothing if the column does not exist or if the

type of the parameter isn t compliant with the column

type.

Parameters:

iParameter

The parameter.

iSheetColumn

The name of the column to be associated with the

parameter.

Note

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

o Sub AddNewRow()

Adds a row in the design table source file. The new row is filled in with values of associated

parameters. ##### Since V5R14 ##### If the file contains at least one empty row between two not

empty rows, the behavior of this method is the same for Excel and Text files : => the new row

containing the current parameters values replaces the first empty row found from the beginning of

the file. RQ : before R14, for text files, the new row was appended at the end of the file. The

empty rows were never filed by this way, so that the new row was not visible in Design Table

dialog.

Returns:

S_OK if succeeded, E_FAIL else.

Note

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

o Func CellAsString(short iRow,

short iColumn) As CATBSTR

Returns the content of a specific cell.

Parameters:

iRow

the index of the row where the cell is located.

iColumn

the index of the column where the cell is located.

Note

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

o Property ColumnsNb() As short (Read Only)

Returns the nb of columns in the design table file.

Note

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

o Property Configuration() As short

Returns or sets the current configuration. Legal values: 1 to

ConfigurationsNb.

Note

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

o Property ConfigurationsNb() As short (Read Only)

Returns the number of design table configurations.

Note

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

o Property CopyMode() As boolean

Returns or sets whether the data contained in the file must be included

inside the CATIA model.

Note

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

o Property FilePath() As CATBSTR

Returns or sets the path of the design table (read/write property).

Note

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

o Sub RemoveAssociation(CATBSTR iSheetColumn)

Removes an existing association. This method does nothing if the column isn

t associated or if it doesn t exist.

Parameters:

iSheetColumn

The name of an associated column.

Note

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

o Sub Synchronize()

Synchronizes the design table with its source file. If the file is managed

in Enovia LCA, copies this file on local disk, and synchronizes design table

content

Note

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

o Property Unit() As Unit (Read Only)

Returns the unit used for this dimension object.

Note

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

o Func ValueAsString2(long iNbDecimals,

boolean iShowTrailingZeros) As CATBSTR

Gets the value of the parameter as a string, with a given

precision.

Parameters:

iNbDecimals

the maximum number of decimal places to use to generate the string

(minimum 0, maximum 9)

iShowTrailingZeros

this argument says if trailing zeros have to be shown

Example:

This example gets the value of the existing dimension parameter and

shows it in a message box

Dim str

str = dimension.ValueAsString;

MessageBox str

Note

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

o Property ValueEnum() As CATBSTR

Returns or sets the value of the EnumParameter object. Units are expressed

in the IS unit system, except for lengths expressed in millimeters, and angles

expressed in decimal degrees.

Example:

This example sets the param1 value to 1 if its value is greater than

2.5:

If (density.Value > 2.5) Then

density.Value = 1

End If

Note

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

o Sub Generate(AnyObject iContext)

Generates the features.

Note

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

o Sub GenerateInContext(CATSafeArrayVariant iInputsArray)

Generates the features.

Note

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

o Sub LoadScriptFromFilePath(CATBSTR iFilePath)

Sets a script from a document file.

Note

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

o Property NbGeneratedFeatures() As long (Read Only)

Number of generated features in last generation.

Note

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

o Property Script() As CATBSTR

Returns or sets the script that describes what is to be generated.

Note

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

o Property InfRange() As double

Returns or sets the inferior bound of the free parameter object. The

optimization cannot escape those bounds.

Note

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

o Property Parameter() As RealParam

Returns or sets which parameter (CATIAParameter) is linked to this object.

The parameter must be real.

Note

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

o Property Step() As double

Returns or sets the initial step used by the optimisation to look for a

better solution. This step is just a preliminary indication. It will vary

during the optimisation process.

Note

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

o Property SupRange() As double

Returns or sets the superior bound of the free parameter object. The

optimization cannot escape those bounds.

Note

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

o Func AddFreeParameter(RealParam parameter) As

FreeParameter

Adds a free parameter. This parameter must not be read only.

Note

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

o Func Item(CATVariant iIndex) As FreeParameter

Retrieves an optimization using its index or its name from the Free

Parameters collection.

Parameters:

iIndex

The index or the name of the free parameter to retrieve from the

collection of free parameters. As a numerics, this index is the rank of the

free parameter in the collection. The index of the first free parameter in the

collection is 1, and the index of the last free parameter is Count. As a

string, it is the name you assigned to the free parameter using the

AnyObject.Name property or when changing the free parameter name by the

property panel.

Returns:

The retrieved free parameter

Example:

This example retrieves the last free parameter in the free parameters

collection.

Set lastFreeParameter = freeParameters.Item(freeParameters.Count)

Note

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

o Sub RemoveFreeParameter(CATVariant iIndex)

Removes a free parameter.

Note

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

o Sub GetEnumerateValues(CATSafeArrayVariant oSafeArray)

Returns an array containing the different values that the int param can

take in the case of multiple values.

Example:

Dim enumValues () as Variant

ReDim enumValues (anIntegerParameter.GetEnumerateValuesSize() -

1)

anIntegerParameter.GetEnumerateValues(enumValues)

For i = LBound(enumValues) to UBound(enumValues)

…

Next

Note

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

o Func GetEnumerateValuesSize() As long

Returns the number of enumerate values.

Note

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

o Property RangeMax() As long

Returns or sets the value of the upper bound that the parameter object

value can take.

Example:

This example sets the RangeMax value to 0 if its value is smaller than

0:

If (Length.RangeMax < 0.0 and Length.RangeMaxValidity <> 0)

Then

Length.RangeMax = 0.0

End If

Note

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

o Property RangeMaxValidity() As long

Returns or sets the type of the upper bound of the

parameter.

0

the upper bound is meaningless

1

the upper bound can be reached

2

the upper bound cannot be reached

Note

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

o Property RangeMin() As long

Returns or sets the value of the lower bound that the parameter object

value can take.

Example:

This example sets the RangeMin value to 0 if its value is bigger than

0:

If (Length.RangeMin > 0.0 and Length.RangeMinValidity <> 0)

Then

Length.RangeMin = 0.0

End If

Note

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

o Property RangeMinValidity() As long

Returns or sets the type of the lower bound of the

parameter.

0

the lower bound is meaningless

1

the lower bound can be reached

2

the lower bound cannot be reached

Note

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

o Sub SetEnumerateValues(CATSafeArrayVariant iSafeArray)

Sets an array containing the different values that the real param can take

in the case of multiple values.

Note

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

o Sub SuppressEnumerateValues()

Resets the status of the object to a single value object.

Note

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

o Property Value() As long

Returns or sets the value of the integer parameter. Units are expressed in

the IS unit system.

Example:

This example sets the year value to 0 if its value is equal to

2000:

If (year.Value = 2000) Then

year.Value = 0

End If

Note

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

o Sub Activate()

Activates the relation. The relation will be processed whenever the value

of one of its input parameter is modified.

Example:

This example activates the maximummass relation:

maximummass.Activate()

Note

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

o Property Activated() As boolean (Read Only)

Returns whether the relation is activated.

True if the relation is activated. An activated relation is processed

whenever the value of one of its input parameter is

modified.

Example:

This example retrieves whether the maximummass relation is activated,

and if true, displays the result in a message box:

If ( maximummass.Activated ) Then

MsgBox “maximummass is activated”

End If

Note

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

o Sub Deactivate()

Deactivates the relation. The relation will no longer be processed when the

value of one of its input parameter is modified.

Example:

This example deactivates the maximummass relation:

maximummass.Deactivate()

Note

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

o Property Hidden() As boolean

Returns or sets wether the relation is hidden or should be hidden. or not.

Note

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

o Property IsConst() As boolean

Returns or sets wether the relation is Const or should be Const. or not.

Note

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

o Property DesignTablesCopyData() As short

Returns or sets the DesignTablesCopyData parameter.

Role:Return or Set the DesignTablesCopyData parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oDesignTablesCopyData

Legal values:

0 : default mode for design table : copy data into models

1 : default mode for design table : do not copy data into models.

Note

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

o Property DesignTablesSynchronization() As short

Returns or sets the DesignTablesSynchronization parameter.

Role:Return or Set the DesignTablesSynchronization parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oDesignTablesSynchronization

Legal values:

0 : automatic synchronization at load for design table

1 : interactive synchronization at load for design table

2 : manual synchronization for design table.

Note

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

o Func GetDesignTablesCopyDataInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DesignTablesCopyData

parameter.

Role:Retrieves the state of the DesignTablesCopyData parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetDesignTablesSynchronizationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DesignTablesSynchronization

parameter.

Role:Retrieves the state of the DesignTablesSynchronization parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetParameterNameSurroundedByTheSymbolInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

ParameterNameSurroundedByTheSymbol parameter.

Role:Retrieves the state of the ParameterNameSurroundedByTheSymbol

parameter in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetParameterTreeViewWithFormulaInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ParameterTreeViewWithFormula

parameter.

Role:Retrieves the state of the ParameterTreeViewWithFormula parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetParameterTreeViewWithValueInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ParameterTreeViewWithValue

parameter.

Role:Retrieves the state of the ParameterTreeViewWithValue parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Retrieves the state of the

RelationsUpdateInPartContextEvaluateDuringUpdate parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetRelationsUpdateInPartContextSynchronousRelationsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Retrieves the state of the

RelationsUpdateInPartContextSynchronousRelations parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Property ParameterNameSurroundedByTheSymbol() As short

Returns or sets the ParameterNameSurroundedByTheSymbol

parameter.

Role:Return or Set the ParameterNameSurroundedByTheSymbol parameter if it

is possible in the current administrative context. In user mode this method

will always return E_FAIL.

Parameters:

oParameterNameSurroundedByTheSymbol

Legal values:

0 : to see parameter name not surrounded by the symbol “’”

1 : to see parameter name surrounded by the symbol “’”.

Note

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

o Property ParameterTreeViewWithFormula() As short

Returns or sets the ParameterTreeViewWithFormula

parameter.

Role:Return or Set the ParameterTreeViewWithFormula parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oParameterTreeViewWithFormula

Legal values:

0 : to see parameter tree view without formula

1 : to see parameter tree view with formula.

Note

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

o Property ParameterTreeViewWithValue() As short

Returns or sets the ParameterTreeViewWithValue parameter.

Role:Return or Set the ParameterTreeViewWithValue parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oParameterTreeViewWithValue

Legal values:

0 : to see parameter tree view without value

1 : to see parameter tree view with value.

Note

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

o Property RelationsUpdateInPartContextEvaluateDuringUpdate() As

short

Returns or sets the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Return or Set the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

oRelationsUpdateInPartContextEvaluateDuringUpdate

Legal values:

0 : creation of relations not evaluate during update

1 : creation of relations evaluate during update.

Note

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

o Property RelationsUpdateInPartContextSynchronousRelations() As

short

Returns or sets the RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Return or Set the RelationsUpdateInPartContextSynchronousRelations

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

oRelationsUpdateInPartContextSynchronousRelations

Legal values:

0 : creation of unsynchronous relations

1 : creation of synchronous relations.

Note

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

o Sub SetDesignTablesCopyDataLock(boolean iLocked)

Locks or unlocks the DesignTablesCopyData parameter.

Role:Locks or unlocks the DesignTablesCopyData parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetDesignTablesSynchronizationLock(boolean iLocked)

Locks or unlocks the DesignTablesSynchronization

parameter.

Role:Locks or unlocks the DesignTablesSynchronization parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetParameterNameSurroundedByTheSymbolLock(boolean

iLocked)

Locks or unlocks the ParameterNameSurroundedByTheSymbol

parameter.

Role:Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter if

it is possible in the current administrative context. In user mode this method

will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetParameterTreeViewWithFormulaLock(boolean iLocked)

Locks or unlocks the ParameterTreeViewWithFormula

parameter.

Role:Locks or unlocks the ParameterTreeViewWithFormula parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetParameterTreeViewWithValueLock(boolean iLocked)

Locks or unlocks the ParameterTreeViewWithValue parameter.

Role:Locks or unlocks the ParameterTreeViewWithValue parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetRelationsUpdateInPartContextEvaluateDuringUpdateLock(boolean

iLocked)

Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetRelationsUpdateInPartContextSynchronousRelationsLock(boolean

iLocked)

Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Property DesignTablesCopyData() As short

Returns or sets the DesignTablesCopyData parameter.

Role:Return or Set the DesignTablesCopyData parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oDesignTablesCopyData

Legal values:

0 : default mode for design table : copy data into models

1 : default mode for design table : do not copy data into models.

Note

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

o Property DesignTablesSynchronization() As short

Returns or sets the DesignTablesSynchronization parameter.

Role:Return or Set the DesignTablesSynchronization parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oDesignTablesSynchronization

Legal values:

0 : automatic synchronization at load for design table

1 : interactive synchronization at load for design table

2 : manual synchronization for design table.

Note

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

o Func GetDesignTablesCopyDataInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DesignTablesCopyData

parameter.

Role:Retrieves the state of the DesignTablesCopyData parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetDesignTablesSynchronizationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DesignTablesSynchronization

parameter.

Role:Retrieves the state of the DesignTablesSynchronization parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetParameterNameSurroundedByTheSymbolInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

ParameterNameSurroundedByTheSymbol parameter.

Role:Retrieves the state of the ParameterNameSurroundedByTheSymbol

parameter in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetParameterTreeViewWithFormulaInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ParameterTreeViewWithFormula

parameter.

Role:Retrieves the state of the ParameterTreeViewWithFormula parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetParameterTreeViewWithValueInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ParameterTreeViewWithValue

parameter.

Role:Retrieves the state of the ParameterTreeViewWithValue parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Retrieves the state of the

RelationsUpdateInPartContextEvaluateDuringUpdate parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Func GetRelationsUpdateInPartContextSynchronousRelationsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Retrieves the state of the

RelationsUpdateInPartContextSynchronousRelations parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

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

o Property ParameterNameSurroundedByTheSymbol() As short

Returns or sets the ParameterNameSurroundedByTheSymbol

parameter.

Role:Return or Set the ParameterNameSurroundedByTheSymbol parameter if it

is possible in the current administrative context. In user mode this method

will always return E_FAIL.

Parameters:

oParameterNameSurroundedByTheSymbol

Legal values:

0 : to see parameter name not surrounded by the symbol “’”

1 : to see parameter name surrounded by the symbol “’”.

Note

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

o Property ParameterTreeViewWithFormula() As short

Returns or sets the ParameterTreeViewWithFormula

parameter.

Role:Return or Set the ParameterTreeViewWithFormula parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oParameterTreeViewWithFormula

Legal values:

0 : to see parameter tree view without formula

1 : to see parameter tree view with formula.

Note

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

o Property ParameterTreeViewWithValue() As short

Returns or sets the ParameterTreeViewWithValue parameter.

Role:Return or Set the ParameterTreeViewWithValue parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oParameterTreeViewWithValue

Legal values:

0 : to see parameter tree view without value

1 : to see parameter tree view with value.

Note

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

o Property RelationsUpdateInPartContextEvaluateDuringUpdate() As

short

Returns or sets the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Return or Set the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

oRelationsUpdateInPartContextEvaluateDuringUpdate

Legal values:

0 : creation of relations not evaluate during update

1 : creation of relations evaluate during update.

Note

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

o Property RelationsUpdateInPartContextSynchronousRelations() As

short

Returns or sets the RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Return or Set the RelationsUpdateInPartContextSynchronousRelations

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

oRelationsUpdateInPartContextSynchronousRelations

Legal values:

0 : creation of unsynchronous relations

1 : creation of synchronous relations.

Note

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

o Sub SetDesignTablesCopyDataLock(boolean iLocked)

Locks or unlocks the DesignTablesCopyData parameter.

Role:Locks or unlocks the DesignTablesCopyData parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetDesignTablesSynchronizationLock(boolean iLocked)

Locks or unlocks the DesignTablesSynchronization

parameter.

Role:Locks or unlocks the DesignTablesSynchronization parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetParameterNameSurroundedByTheSymbolLock(boolean

iLocked)

Locks or unlocks the ParameterNameSurroundedByTheSymbol

parameter.

Role:Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter if

it is possible in the current administrative context. In user mode this method

will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetParameterTreeViewWithFormulaLock(boolean iLocked)

Locks or unlocks the ParameterTreeViewWithFormula

parameter.

Role:Locks or unlocks the ParameterTreeViewWithFormula parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetParameterTreeViewWithValueLock(boolean iLocked)

Locks or unlocks the ParameterTreeViewWithValue parameter.

Role:Locks or unlocks the ParameterTreeViewWithValue parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetRelationsUpdateInPartContextEvaluateDuringUpdateLock(boolean

iLocked)

Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub SetRelationsUpdateInPartContextSynchronousRelationsLock(boolean

iLocked)

Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

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

o Sub AddFormalParameter(CATBSTR iName,

CATBSTR iMagnitude)

Creates a formal parameter for the law.

Parameters:

iName

The name of the formal parameter.

iType

The type name of the formal parameter.

Note

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

o Sub RemoveFormalParameter(CATBSTR iName)

Removes a formal parameter of the law.

Parameters:

iName

The name of the formal parameter.

Note

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

o Sub Add(AnyObject iItemValue)

Adds an item at the end of the list. Does an AddRef on the item. Returns

E_FAIL if the object type is not correct. Will return E_FAIL if trying to set

an already existing element while IsDuplicateElementsAllowed is false.

Note

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

o Func Item(CATVariant iIndex) As AnyObject

Retrieves a Feature using its index or its name from the Features

collection.

Parameters:

iIndex

The index or the name of the Feature to retrieve from the

collection of Features. As a numerics, this index is the rank of the Feature in

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

index of the last Feature is Count. As a string, it is the name you assigned to

the Feature using the

AnyObject.Name property or when creating the Feature.

Returns:

The retrieved Feature

Example:

This example retrieves the last Feature in the Features

collection.

Dim lastFeature As CATIABase

Set lastFeature = Features.Item(Features.Count)

Note

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

o Sub Remove(CATVariant iIndex)

Removes a Feature from the Features collection.

Parameters:

iIndex

The index or the name of the Feature to retrieve from the

collection of Features. As a numerics, this index is the rank of the Feature in

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

index of the last Feature is Count. As a string, it is the name you assigned to

the Feature using the

AnyObject.Name property or when creating the Feature.

Example:

This example removes the Feature named density from the Features

collection.

Features.Remove(“density”)

Note

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

o Sub Reorder(CATVariant iIndexCurrent,

CATVariant iIndexTarget)

Reorders an element by moving it from the current position to the target

position. Doesn’t change the list if either position is out of the list. Return

E_FAIL if cannot reorder.

Note

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

o Sub Replace(CATVariant iIndex,

AnyObject iItemValue)

Sets an item in the list at a position. Does an AddRef on the item. Returns

E_FAIL if the object type is not correct or the index is out of bounds. Returns

E_FAIL if trying to set an already existing element while

IsDuplicateElementsAllowed is false.

Note

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

o Property ValueList() As List (Read Only)

Returns or sets the value of the List object.

Note

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

o Property AlgorithmType() As CatAlgorithmType

Returns or sets the algorithm type. Currently available algorithms are

gradient and simulatedAnnealing

See also:

CatAlgorithmType

Note

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

o Property Constraints() As OptimizationConstraints (Read

Only)

Returns the collection of optimization constraints.

Note

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

o Property ConvSpeed() As long

Returns or sets the convergence speed for some gradients and the simulated

annealing.

Note

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

o Property FreeParameters() As FreeParameters (Read Only)

Returns the collection of the free parameters.

Note

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

o Property MaxEvalsNb() As long

Returns or sets the maximum number of model updates allowed during one run

of the optimization.

Note

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

o Property MaxEvalsWoImprovement() As long

Returns or sets the maximum number of model updates without improvement of

the problem solution during one run of the optimization.

Note

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

o Property MaxTime() As long

Returns or sets the maximum time allowed for one run of the optimization

(in minutes).

Note

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

o Property ObjectiveParameter() As RealParam

Returns or sets the objective parameter of the optimization. This parameter

can not exist (in this case the get method returns E_FAIL) when the

optimization contains only constraints and uses Simulated Annealing, or if the

optimization feature doesn’t contain all information necessary to be run.

Note

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

o Property OptimizationType() As CatOptimizationType

Returns or sets the type of the optimization: minimum, maximum or target

value searched on the objective parameter.

See also:

CatOptimizationType

Note

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

o Sub Run(boolean iWithStopDialog)

Runs the optimization as it is defined. The stop dialog appears if argument

is TRUE

Before running, a check is made to ensure that the optimization feature

contains enough information to run the optimization. In the case where some

information is missing, this method returns E_FAIL

WARNING : if argument is TRUE, the optimization is launched asynchronously, and you can not run

several optimizations in this mode.

Note

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

o Property TargetValue() As RealParam (Read Only)

Returns the objective parameter target value. (used only if the

optimization type is a target value search)

Note

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

o Property UseMaxEvalsWoImprovement() As boolean

Returns or sets if the number of updates without improvement of the

solution has to be used as a termination criterion.

Note

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

o Property UseMaxTime() As boolean

Returns or sets if max time has to be used as a termination criterion.

Note

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

o Property DistanceToSatisfaction() As RealParam (Read Only)

Returns the parameter containing the distance to constraint satisfaction.

Note

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

o Property Precision() As double

Returns or sets the constraint precision. Only for equality

constraints.

The constraint precision allows the system to know when an equality constraint can be declared as

satisfied (when : distance to satisfaction < precision).

Note

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

o Property Satisfaction() As boolean (Read Only)

Returns the constraint satisfaction.

Note

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

o Func AddConstraint(CATBSTR constraintExpression) As

OptimizationConstraint

Adds a optimization constraint. This parameter must not be read only.

Note

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

o Func Item(CATVariant iIndex) As OptimizationConstraint

Returns an optimization constraint using its index or its name from the

optimization constraints collection.

Parameters:

iIndex

The index or the name of the optimization constraint to retrieve

from the collection of optimization constraints. As a numerics, this index is

the rank of the optimization constraint in the collection. The index of the

first optimization constraint in the collection is 1, and the index of the last

optimization constraint is Count. As a string, it is the name you assigned to

the optimization constraint using the

AnyObject.Name property or when changing the optimization constraint

name by the property panel.

Returns:

The retrieved optimization constraint

Example:

This example retrieves the last optimization constraint in the

optimization constraints collection.

Set lastConstraint = constraints.Item(constraints.Count)

Note

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

o Sub RemoveConstraint(CATVariant iIndex)

Removes a given optimization constraint using its index or its name from

the optimization constraints collection.

Parameters:

iIndex

the name of the constraint if argument is a string or the index of

the constraint if argument is an integer.

Note

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

o Func CreateConstraintsSatisfaction(CATBSTR iName,

CATBSTR iComment,

CATBSTR iFormulaBody) As SetOfEquation

Returns a set of equations.

Parameters:

iName

The name of the set of equations.

iComment

The comment of the set of equations.

iFormulaBody

The body of the set of equations ” a==b+4; c ≤

90”.

Note

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

o Func CreateOptimization() As Optimization

Creates an empty optimization.

This optimization cannot be used while its properties have not been set.

Note

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

o Func Item(CATVariant iIndex) As AnyObject

Retrieves an optimization using its index or its name from the

Optimizations collection.

Parameters:

iIndex

The index or the name of the item (optimization or

constraintSatisfaction) to retrieve from the collection of optimizations. As a

numerics, this index is the rank of the item in the collection. The index of

the first item in the collection is 1, and the index of the last item is Count.

As a string, it is the name you assigned to the item using the

AnyObject.Name property or when changing the item name by the property

panel.

Returns:

either the retrieved optimization or the retreived

constraintSatisfaction

Example:

This example retrieves the last item (optimization or

constraintSatisfaction) in the optimizations

collection.

Set lastItem = optimizations.Item(optimizations.Count)

Note

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

o Property Comment() As CATBSTR

Returns or sets the parameter object comment.

Note

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

o Property Context() As AnyObject (Read Only)

Returns the context of the parameter : a part, a product, a drafting, a process, depending where

the parameter is.

Note

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

o Property Hidden() As boolean

Returns or sets wether the parameter is hidden or should be hidden. or not.

Note

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

o Property IsTrueParameter() As boolean (Read Only)

Returns a boolean saying if the parameter is a true one (real, dimension,

string, etc.) or a geometrical one (isolated points, curves, surfaces).

Note

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

o Property OptionalRelation() As Relation (Read Only)

Returns the relation that can be used to compute the parameter. As this

relation might not exist, NULL may be returned, so a test is

required.

Example:

This example checks if there is a relation to compute the param1

parameter, and if no relation exists, displays a message

box:

Set param1_rel = param1.OptionalRelation

If param1_rel is Nothing Then

MsgBox “No relation to compute param1”

End If

Note

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

o Property ReadOnly() As boolean (Read Only)

Returns whether the parameter can be modified.

Example:

This example checks if the param1 parameter can be modified, and if it

cannot, displays a message box:

If ( param1.ReadOnly ) Then

MsgBox “No way to change param1”

End If

Note

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

o Property Renamed() As boolean (Read Only)

Returns a boolean saying if the parameter is a renamed parameter or not.

Note

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

o Property UserAccessMode() As long (Read Only)

Returns the user access mode of the parameter.

0

Read only parameter (cannot be destroyed).

1

Read/write parameter (cannot be destroyed).

2

User parameter (can be read, written and destroyed).

Methods

o Sub Rename(CATBSTR iName)

Renames the parameter.

Parameters:

iName

The new name of the parameter. If iName contains “Local:” prefix

the rename will affect the local name. If not, it will affect the global name.

Example:

This example renames the param1 parameter to

PartSeatbodyMinimumThickness:

Call param1.Rename(“PartSeatbodyMinimumThickness”)

o Sub ValuateFromString(CATBSTR iValue)

Valuates a parameter using a string as input. The string depends on

parameter nature :

“True” or “False” for Boolean

a numerical value for Integer or Real

a numerical value with or without a unit for Dimension

Parameters:

iValue

The value to assign to the dimension parameter

Example:

This example sets the value of the existing dimension parameter to a

new value:

dimension.ValuateFromString(“300mm”);

o Func ValueAsString() As CATBSTR

Returns the value of the parameter as a string.

Example:

This example gets the value of the existing dimension parameter and shows

it in a message box

Dim str

str = dimension.ValueAsString;

MessageBox str

Copyright © 1999-2011, Dassault Systèmes. All rights

reserved.

Note

CAA V5 Visual Basic help

AllParameters

o Property AllParameters() As Parameters

Returns all parameters under this set of parameter.

Parameters:

Note

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

o Property DirectParameters() As Parameters (Read Only)

Returns directly aggregated parameters.

Note

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

o Property ParameterSets() As ParameterSets (Read Only)

Returns the children parameter sets.

Note

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

o Func CreateSet(CATBSTR iName) As ParameterSet

Creates a set of parameters and appends it to the parameter set which

corresponds to this collection.

Note

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

o Func Item(CATVariant iIndex) As ParameterSet

Returns a parameter set using its index or its name from the ParameterSets

collection.

Parameters:

iIndex

The index or the name of the parameter set to retrieve from the

collection of parameter sets. As a numerics, this index is the rank of the

parameter set in the collection. The index of the first parameter set in the

collection is 1, and the index of the last parameter set is Count. As a string,

it is the name you assigned to the parameter set using the

AnyObject.Name property .

Example:

This example retrieves the parameter set named “Parameters.1” in the

parameterSets collection:

Set theSet = parameterSets.Item(“Parameters.1”)

Note

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

o Func CreateBoolean(CATBSTR iName,

boolean iValue) As BoolParam

Creates a boolean parameter and adds it to the part’s collection of

parameters.

Parameters:

iName

The parameter name

iValue

The parameter value

Example:

This example creates the checked boolean parameter and adds it to the

newly created part:

Dim CATDocs As Documents

Set CATDocs = CATIA.Documents

Dim part1 As Document

Set part1 = CATDocs.Add(“CATPart”)

Dim chk As BooleanParam

Set chk = part1.Part.Parameters.CreateBoolean (“checked”, False)

Note

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

o Func CreateDimension(CATBSTR iName,

CATBSTR iMagnitude,

double iValue) As Dimension

Creates a user dimension and adds it to the part’s collection of

parameters.

Parameters:

iName

The dimension name

iMagnitude

The dimension magnitude. Units are those of the IS system. Valid

magnitudes are:

“LENGTH”: the unit is the meter.

“ANGLE”: the unit is the radian.

The

Dimension object provides the Dimension.ValuateFromString method with

which you may express the value in any unit for a given dimension (see the

example below).

iValue

The dimension value provided as a real number

Example:

This example creates a LENGTH dimension and adds it to the newly

created part. The initial value is expressed in meters. The new value is

expressed in millimeters.

Dim depth As Dimension

Set depth = parameters.CreateDimension(“depth”, “LENGTH”, 20)

depth.ValuateFromString(“300mm”);

Note

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

o Func CreateInteger(CATBSTR iName,

long iValue) As IntParam

Creates an integer parameter and adds it to the part’s collection of

parameters.

Parameters:

iName

The parameter name

iValue

The parameter value

Example:

This example creates the RevisionNumber integer parameter and adds it

to the newly created part:

Dim CATDocs As Documents

Set CATDocs = CATIA.Documents

Dim part1 As Document

Set part1 = CATDocs.Add(“CATPart”)

Dim revision As IntParam

Set revision = part1.Part.Parameters.CreateInteger (“RevisionRumber”, 17)

Note

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

o Func CreateList(CATBSTR iName) As ListParameter

Creates a list parameter and adds it to the part’s collection of

parameters.

Parameters:

iName

The parameter name

Example:

This example creates the ListName list parameter and adds it to the

newly created part:

Set CATDocs = CATIA.Documents

Set part1 = CATDocs.Add(“CATPart”)

Set list1 = part1.Part.Parameters.CreateList (“ListName”)

Note

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

o Func CreateReal(CATBSTR iName,

double iValue) As RealParam

Creates a real parameter and adds it to the part’s collection of

parameters.

Parameters:

iName

The parameter name

iValue

The parameter value

Example:

This example creates the ReliabilityRate real parameter and adds it to

the newly created part:

Dim CATDocs As Documents

Set CATDocs = CATIA.Documents

Dim part1 As Document

Set part1 = CATDocs.Add(“CATPart”)

Dim rate As RealParam

Set rate = part1.Part.Parameters.CreateReal (“ReliabilityRate”, 2.5 )

Note

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

o Sub CreateSetOfParameters(AnyObject iFather)

Creates a set of parameters and appends it to argument iFather.

Note

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

o Func CreateString(CATBSTR iName,

CATBSTR iValue) As StrParam

Creates a string parameter and adds it to the part’s collection of

parameters.

Parameters:

iName

The parameter name

iValue

The parameter value

Example:

This example creates the responsible string parameter and adds it to

the newly created part:

Set CATDocs = CATIA.Documents

Set part1 = CATDocs.Add(“CATPart”)

Set density = part1.Part.Parameters.CreateString (“responsible”, “The Boss”)

Note

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

o Func GetNameToUseInRelation(AnyObject iObject) As CATBSTR

Returns a correct name of a feature to use it in a relation.

Note

CAA V5 Visual Basic help

Item

o Func Item( CATVariant iIndex) As Parameter

Retrieves a parameter using its index or its name from the from the

Parameters collection.

Parameters:

iIndex

The index or the name of the parameter to retrieve from

the collection of parameters.

As a numeric, this index is the rank of the parameter

in the collection.

The index of the first parameter in the collection is 1, and

the index of the last parameter is Count.

As a string, it is the name you assigned to the parameter using

the

activateLinkAnchor(‘AnyObject’,’Name’,’AnyObject.Name’) property or when

creating the parameter.

Examples:

This example retrieves the last parameter in the parameters

collection:

Set lastParameter = parameters.Item(parameters.Count)

Note

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

o Sub Remove(CATVariant iIndex)

Removes a parameter from the Parameters collection.

Parameters:

iIndex

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

collection of parameters. As a numerics, this index is the rank of the

parameter in the collection. The index of the first parameter in the collection

is 1, and the index of the last parameter is Count. As a string, it is the name

you assigned to the parameter using the

AnyObject.Name property or when creating the parameter.

Example:

This example removes the “depth” parameter from the parameters

collection.

parameters.Remove(“depth”)

Note

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

o Property RootParameterSet() As ParameterSet (Read Only)

Returns the root parameter set of a document. If it doesn’t exist, it is

created.

Note

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

o Func SubList(AnyObject iObject,

boolean iRecursively) As Parameters

Returns a sub-collection of parameters aggregated to an

object.

Parameters:

iObject

The object used to filter the whole parameter collection to get the

resulting sub-collection.

iRecursively

A flag to specify if children parameters are to be searched for in

the returned collection

Example:

This example shows how to retrieve a collection of parameters that

are associated to a Pad.

Dim Parameters1 As Parameters

Set Parameters1 = CATIA.ActiveDocument.Part.Parameters gets the collection of parameters

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 Parameters2 As Parameters

Set Parameters2 = Parameters1.SubList(Pad1,TRUE) gets the collection of parameters that

are under the pad Pad.1

Note

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

o Property Units() As Units (Read Only)

Returns the collection of units.

Note

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

o Sub GetEnumerateValues(CATSafeArrayVariant oSafeArray)

Returns an array containing the different values that the real param can

take in the case of multiple values.

Example:

Dim enumValues () as Variant

ReDim enumValues (aRealParameter.GetEnumerateValuesSize() -

1)

aRealParameter.GetEnumerateValues(enumValues)

For i = LBound(enumValues) to UBound(enumValues)

…

Next

Note

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

o Func GetEnumerateValuesSize() As long

Returns the number of enumerate values.

Note

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

o Func IsEqualTo(double iValueToCompare) As boolean

Tests the equality of the parameter value with a given

value.

Parameters:

iValueToCompare

The value to compare the parameter value with

Returns:

True

If the current value of the parameter (the one get by the get_Value

property, for dimensions notice that it is not the MKS value) is equal to the

one given in argument. Notice that two values are considered as equal if their

difference is insignificant faced with the two compared values. This method

allows you to avoid problems due to computation

errors.

False

If the two values are different.

Note

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

o Property MaximumTolerance() As double

Returns or sets the value of the maximum tolerance of a parameter. Units

are expressed in the IS unit system.

Example:

This example sets the MaximumTolerance value to 0 if its value is

bigger than 0:

If (Length.MaximumTolerance < 0.0) Then

Length.MaximumTolerance = 0.0

End If

Note

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

o Property MinimumTolerance() As double

Returns or sets the value of the minimum tolerance of a parameter. Units

are expressed in the IS unit system.

Example:

This example sets the MinumumTolerance value to 0 if its value is

bigger than 0:

If (Length.MinimumTolerance > 0.0) Then

Length.MinimumTolerance = 0.0

End If

Note

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

o Property RangeMax() As double

Returns or sets the value of the upper bound that the parameter object

value can take.

Example:

This example sets the RangeMax value to 0 if its value is smaller than

0:

If (Length.RangeMax < 0.0 and Length.RangeMaxValidity <> 0)

Then

Length.RangeMax = 0.0

End If

Note

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

o Property RangeMaxValidity() As long

Returns or sets the type of the upper bound of the

parameter.

0

the upper bound is meaningless

1

the upper bound can be reached

2

the upper bound cannot be reached

Note

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

o Property RangeMin() As double

Returns or sets the value of the lower bound that the parameter object

value can take.

Example:

This example sets the RangeMin value to 0 if its value is bigger than

0:

If (Length.RangeMin > 0.0 and Length.RangeMinValidity <> 0)

Then

Length.RangeMin = 0.0

End If

Note

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

o Property RangeMinValidity() As long

Returns or sets the type of the lower bound of the

parameter.

0

the lower bound is meaningless

1

the lower bound can be reached

2

the lower bound cannot be reached

Note

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

o Sub SetEnumerateValues(CATSafeArrayVariant iSafeArray)

Sets an array containing the different values that the real param can take

in the case of multiple values.

Note

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

o Sub SuppressEnumerateValues()

Resets the status of the object to a single value object.

Note

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

o Property Value() As double

Returns or sets the value of the real parameter. Units are expressed in the

IS unit system, except for lengths expressed in millimeters, and angles

expressed in decimal degrees.

Example:

This example sets the density value to 1 if its value is greater than

2.5:

If (density.Value > 2.5) Then

density.Value = 1

End If

Note

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

o Property Comment() As CATBSTR

Returns or sets the comment associated with the relation. The comment

explains the relation’s purpose. It is passed as the second input argument of

the relation creation methods of the Relations collection.

Example:

This example retrieves the maximummass relation comment and displays it

in a message box:

relcomment = maximummass.Comment

MsgBox “maximummass comment : ” & relcomment

Note

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

o Property Context() As AnyObject (Read Only)

Returns the context of the parameter.

The context of a parameter can be a part, a product, a drafting, or a

process document, depending where the parameter is.

Returns:

The context

See also:

Part, Product, CATIADrawing, CATIAProcess

Note

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

o Func GetInParameter(long iIndex) As AnyObject

Returns an input parameter of the relation.

This method can return an object that is not a parameter, that is, you

cannot handle it as a Parameter object. For example, in a relation

like

Area.1 = area(PartBody/Pad.1/Sketch.1)

the object PartBody/Pad.1/Sketch.1 is a sketch and not a

parameter.

To use such an object, call the Visual Basic TypeName function to retrieve

its real type.

Dim objectType

objectType = TypeName(oParameter)

If objectType = “Parameter” Then

…

Parameters:

iIndex

The searched input parameter index in the

relation.

Legal values: 1 ≤ iIndex ≤

NbInParameters

Note

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

o Func GetOutParameter(long iIndex) As Parameter

Returns an output parameter of the relation. Use TypeName method on the

returned parameter to get the real type of the parameter.

Parameters:

iIndex

The searched input parameter index in the

relation.

Legal values: 1 ≤ iIndex ≤

NbOutParameters

Note

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

o Sub Modify(CATBSTR iValue)

Modifies the relation.

Parameters:

iValue

The new relation value

Note

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

o Property NbInParameters() As long (Read Only)

Returns the number of input parameters of the relation.

Note

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

o Property NbOutParameters() As long (Read Only)

Returns the number of output parameters of the relation.

The output parameters of the relation are those constrained by the

relation.

Note

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

o Sub Rename(CATBSTR iName)

Renames the relation.

Parameters:

iName

The new relation name

Note

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

o Property Value() As CATBSTR (Read Only)

Returns the definition of the relation. It returns an empty string if the

relation is not an expressional one (for example for a design table). The

definition is the body to be executed to compute one or several parameters. It

is passed as the last input argument of the relation creation methods of the

Relations collection.

Example:

This example retrieves the maximummass relation definition and displays

it in a message box:

reldef = maximummass.Value

MsgBox “maximummass relation is defined as ” & reldef