CalculationToolConditionFactory

class ansys.stk.core.analysis_workbench.CalculationToolConditionFactory

The factory creates condition components.

Overview

Methods

create	Create and registers a condition using specified name, description and type.
create_scalar_bounds	Create a condition placing bounds on specified scalar.
is_type_supported	Return whether the specified type is supported.
create_combined	Create a condition which combines multiple conditions.
create_trajectory_within_volume	Create a condition for point in volume.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolConditionFactory

Method detail

CalculationToolConditionFactory.create(self, name: str, description: str, type: ConditionType) → ICalculationToolCondition

Create and registers a condition using specified name, description and type.

Parameters:

name : str

description : str

type : ConditionType

Returns:

ICalculationToolCondition

CalculationToolConditionFactory.create_scalar_bounds(self, name: str, description: str) → ICalculationToolCondition

Create a condition placing bounds on specified scalar.

Parameters:

name : str

description : str

Returns:

ICalculationToolCondition

CalculationToolConditionFactory.is_type_supported(self, type: ConditionType) → bool

Return whether the specified type is supported.

Parameters:

type : ConditionType

Returns:

bool

CalculationToolConditionFactory.create_combined(self, name: str, description: str) → ICalculationToolCondition

Create a condition which combines multiple conditions.

Parameters:

name : str

description : str

Returns:

ICalculationToolCondition

CalculationToolConditionFactory.create_trajectory_within_volume(self, name: str, description: str) → ICalculationToolCondition

Create a condition for point in volume.

Parameters:

name : str

description : str

Returns:

ICalculationToolCondition