CalculationToolScalarCustomInlineScript#

class ansys.stk.core.analysis_workbench.CalculationToolScalarCustomInlineScript#

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

A calc scalar based on using an inline scripted algorithm in MATLAB, Perl, VBScript or JScript to define its value and rate.

Overview#

get_all_arguments

Return the list of arguments.

set_all_arguments

Set the list of arguments.

script_type

Script type allowed {JScript | Matlab | VBScript}.

value_function

The Value function to be evaluated.

derivative_function

The Derivative function to be evaluated.

dimension

Dimension name.

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolScalarCustomInlineScript

Property detail#

property CalculationToolScalarCustomInlineScript.script_type: str#

Script type allowed {JScript | Matlab | VBScript}.

property CalculationToolScalarCustomInlineScript.value_function: str#

The Value function to be evaluated.

property CalculationToolScalarCustomInlineScript.derivative_function: str#

The Derivative function to be evaluated.

property CalculationToolScalarCustomInlineScript.dimension: str#

Dimension name.

Method detail#

CalculationToolScalarCustomInlineScript.get_all_arguments(self) list#

Return the list of arguments.

Returns:

list

CalculationToolScalarCustomInlineScript.set_all_arguments(self, calc_list: list) None#

Set the list of arguments.

Parameters:

calc_list : list

Returns:

None