SpatialAnalysisToolConditionSpatialCalculationBounds

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolConditionSpatialCalculationBounds

Bases: ISpatialAnalysisToolVolume, IAnalysisWorkbenchComponent

An volume from calc volume interface.

Overview

Methods

get_minimum	Get the minimum bound value from the bounds. Call SetMinimum to apply changes.
set_minimum	Set the minimum bound value for the bounds.
get_maximum	Get the maximum bound value from the bounds. Call SetMaximum to apply changes.
set_maximum	Set the maximum bound value for the condition.
set	Set the min/max bounds. Throws an exception if the minimum is greater than maximum.

Properties

operation	Get the operation from the condition that determines how the bounds are considered. The operation can be set to define satisfaction when the scalar is above minimum, below maximum, between minimum and maximum or outside minimum and maximum.
spatial_calculation	Get the volume calc from the bounds.

Import detail

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolConditionSpatialCalculationBounds

Property detail

property SpatialAnalysisToolConditionSpatialCalculationBounds.operation: ConditionThresholdType

Get the operation from the condition that determines how the bounds are considered. The operation can be set to define satisfaction when the scalar is above minimum, below maximum, between minimum and maximum or outside minimum and maximum.

property SpatialAnalysisToolConditionSpatialCalculationBounds.spatial_calculation: ISpatialAnalysisToolSpatialCalculation

Get the volume calc from the bounds.

Method detail

SpatialAnalysisToolConditionSpatialCalculationBounds.get_minimum(self) → Quantity

Get the minimum bound value from the bounds. Call SetMinimum to apply changes.

Returns:

Quantity

SpatialAnalysisToolConditionSpatialCalculationBounds.set_minimum(self, value: Quantity) → None

Set the minimum bound value for the bounds.

Parameters:

value : Quantity

Returns:

None

SpatialAnalysisToolConditionSpatialCalculationBounds.get_maximum(self) → Quantity

Get the maximum bound value from the bounds. Call SetMaximum to apply changes.

Returns:

Quantity

SpatialAnalysisToolConditionSpatialCalculationBounds.set_maximum(self, value: Quantity) → None

Set the maximum bound value for the condition.

Parameters:

value : Quantity

Returns:

None

SpatialAnalysisToolConditionSpatialCalculationBounds.set(self, min: Quantity, max: Quantity) → None

Set the min/max bounds. Throws an exception if the minimum is greater than maximum.

Parameters:

min : Quantity

max : Quantity

Returns:

None