CalculationToolConditionCombined

class ansys.stk.core.analysis_workbench.CalculationToolConditionCombined

Bases: ICalculationToolCondition, IAnalysisWorkbenchComponent

Define a condition which combines multiple conditions.

Overview

Methods

add_condition	Add a condition at the end of the list.
get_all_conditions	Get all conditions that are being combined.
get_condition	Get the condition at the position specified.
remove_condition	Remove the condition at the position specified.
set_all_conditions	Set all conditions to be combined.
set_condition	Set the condition at the position specified.

Properties

boolean_operation	Get the operation from the condition that determines how the conditions are combined. The operation can be set to AND, OR, XOR, MINUS.
count	Get the number of conditions in the combined condition.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolConditionCombined

Property detail

property CalculationToolConditionCombined.boolean_operation: ConditionCombinedOperationType

Get the operation from the condition that determines how the conditions are combined. The operation can be set to AND, OR, XOR, MINUS.

property CalculationToolConditionCombined.count: int

Get the number of conditions in the combined condition.

Method detail

CalculationToolConditionCombined.add_condition(self, ref: ICalculationToolCondition) → None

Add a condition at the end of the list.

Parameters:

ref : ICalculationToolCondition

Returns:

None

CalculationToolConditionCombined.get_all_conditions(self) → list

Get all conditions that are being combined.

Returns:

list

CalculationToolConditionCombined.get_condition(self, pos: int) → ICalculationToolCondition

Get the condition at the position specified.

Parameters:

pos : int

Returns:

ICalculationToolCondition

CalculationToolConditionCombined.remove_condition(self, pos: int) → None

Remove the condition at the position specified.

Parameters:

pos : int

Returns:

None

CalculationToolConditionCombined.set_all_conditions(self, conditions: list) → None

Set all conditions to be combined.

Parameters:

conditions : list

Returns:

None

CalculationToolConditionCombined.set_condition(self, ref: ICalculationToolCondition, pos: int) → None

Set the condition at the position specified.

Parameters:

ref : ICalculationToolCondition

pos : int

Returns:

None