pycatia.knowledge_interfaces.optimization

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.optimization.Optimization(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
KnowledgeInterfaces.KnowledgeObject
Optimization

Represents an Optimization object.
property algorithm_type: int

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
Returns

int

Return type

int

property constraints: pycatia.knowledge_interfaces.optimization_constraints.OptimizationConstraints

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.
Returns

OptimizationConstraints

Return type

OptimizationConstraints

property conv_speed: int

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.
Returns

int

Return type

int

property free_parameters: pycatia.knowledge_interfaces.free_parameters.FreeParameters

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.
Returns

FreeParameters

Return type

FreeParameters

property max_evals_nb: int

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.
Returns

int

Return type

int

property max_evals_wo_improvement: int

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.
Returns

int

Return type

int

property max_time: int

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).
Returns

int

Return type

int

property objective_parameter: pycatia.knowledge_interfaces.real_param.RealParam

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.
Returns

RealParam

Return type

RealParam

property optimization_type: int

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
Returns

int

Return type

int

run(i_with_stop_dialog: bool) → None

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.
Parameters

i_with_stop_dialog (bool) –

Returns

None

Return type

None

property target_value: pycatia.knowledge_interfaces.real_param.RealParam

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)
Returns

RealParam

Return type

RealParam

property use_max_evals_wo_improvement: bool

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.
Returns

bool

Return type

bool

property use_max_time: bool

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.
Returns

bool

Return type

bool