pycatia.knowledge_interfaces.free_parameters

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

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.knowledge_interfaces.free_parameters.FreeParameters(com_object)

Note

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

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

FreeParameters

Interface to access a CATIAFreeParameters.

add_free_parameter(parameter: RealParam) → FreeParameter

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.

Parameters:

parameter (RealParam) –

Return type:

FreeParameter

item(i_index: cat_variant) → FreeParameter

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)

Parameters:

i_index (cat_variant) –

Return type:

FreeParameter

remove_free_parameter(i_index: cat_variant) → None

Note

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

o Sub RemoveFreeParameter(CATVariant iIndex)

Removes a free parameter.

Parameters:

i_index (cat_variant) –

Returns:

None