CalculationToolConditionSetScalarThresholds

class ansys.stk.core.analysis_workbench.CalculationToolConditionSetScalarThresholds

Bases: ICalculationToolConditionSet, IAnalysisWorkbenchComponent

Condition set based on single scalar calculation compared to set of threshold values.

Overview

Methods

set_thresholds_and_labels

Set thresholds and threshold labels.

Properties

scalar	The input scalar calculation.
thresholds	The input threshold values, flags indicating whether to include conditions above the highest and below the lowest threhsolds, and corresponding labels.
threshold_labels	The input threshold values, flags indicating whether to include conditions above the highest and below the lowest threhsolds, and corresponding labels.
include_above_highest_threshold	The threshold indicates whether to include conditions above the highest threhsold.
include_below_lowest_threshold	The threshold indicates whether to include conditions below the lowest threhsolds.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolConditionSetScalarThresholds

Property detail

property CalculationToolConditionSetScalarThresholds.scalar: ICalculationToolScalar

The input scalar calculation.

property CalculationToolConditionSetScalarThresholds.thresholds: list

The input threshold values, flags indicating whether to include conditions above the highest and below the lowest threhsolds, and corresponding labels.

property CalculationToolConditionSetScalarThresholds.threshold_labels: list

The input threshold values, flags indicating whether to include conditions above the highest and below the lowest threhsolds, and corresponding labels.

property CalculationToolConditionSetScalarThresholds.include_above_highest_threshold: bool

The threshold indicates whether to include conditions above the highest threhsold.

property CalculationToolConditionSetScalarThresholds.include_below_lowest_threshold: bool

The threshold indicates whether to include conditions below the lowest threhsolds.

Method detail

CalculationToolConditionSetScalarThresholds.set_thresholds_and_labels(self, thresholds: list, threshold_labels: list) → None

Set thresholds and threshold labels.

Parameters:

thresholds : list

threshold_labels : list

Returns:

None