pycatia.knowledge_interfaces.set_of_equation

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.set_of_equation.SetOfEquation(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

KnowledgeInterfaces.KnowledgeActivateObject

KnowledgeInterfaces.Relation

SetOfEquation

Represents the set of equations object.

get_max_calculation_time() → int

Note

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

o Func GetMaxCalculationTime() As long

Returns the maximum time of the model calculations.

Returns

int

Return type

int

get_precision() → float

Note

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

o Func GetPrecision() As double

Returns the calculation precision.

Returns

float

Return type

float

get_symbolc_transformations() → bool

Note

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

o Func GetSymbolcTransformations() As boolean

Returns whether the Gauss method is used during the symbolic

transformation.

TRUE if the Gauss method is used during the symbolic transformation.

Returns

bool

Return type

bool

is_stop_dialog() → bool

Note

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

o Func IsStopDialog() As boolean

Returns whether the “Stop Dialog” will be shown during

calculations.

TRUE if the ‘Stop Dialog’ will be shown during calculations.

Returns

bool

Return type

bool

set_max_calculation_time(i_max_time: int) → None

Note

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

o Sub SetMaxCalculationTime(long iMaxTime)

Sets a maximum time to the model calculations.

Parameters

i_max_time (int) –

Returns

None

Return type

None

set_parameter_as_input(i_parameter: Parameter) → None

Note

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

o Sub SetParameterAsInput(Parameter iParameter)

Specifies that the parameter must be considered as input

parameter.

Parameters:

iParameter

The parameter to set up as input of the

SetOfEquationObject

Parameters

i_parameter (Parameter) –

Returns

None

Return type

None

set_parameter_as_output(i_parameter: Parameter) → None

Note

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

o Sub SetParameterAsOutput(Parameter iParameter)

Specifies that the parameter must be considered as an output

parameter.

Parameters:

iParameter

The parameter to set up as output of the

SetOfEquationObject

Parameters

i_parameter (Parameter) –

Returns

None

Return type

None

set_precision(i_eps: float) → None

Note

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

o Sub SetPrecision(double iEps)

Sets the calculation precision.

Parameters:

iEps

a precision

Legal values: 1e-10 ≤ iEps ≤ 0.1

Parameters

i_eps (float) –

Returns

None

Return type

None

use_stop_dialog(i_used: bool) → None

Note

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

o Sub UseStopDialog(boolean iUsed)

Specifies whether the ‘Stop Dialog’ should be shown during

calculations.

TRUE to show the ‘Stop Dialog’ during calculations.

Parameters

i_used (bool) –

Returns

None

Return type

None

use_symbolc_transformations(i_gauss: bool) → None

Note

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

o Sub UseSymbolcTransformations(boolean iGauss)

Specifies whether the Gauss method should be used during the symbolic

transformation.

TRUE to use the Gauss method during the symbolic transformation.

Parameters

i_gauss (bool) –

Returns

None

Return type

None