SpatialAnalysisToolConditionCombined#

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolConditionCombined#

Bases: ISpatialAnalysisToolVolume, IAnalysisWorkbenchComponent

A combined volume interface.

Overview#

get_all_conditions

Get all spatial conditions.

set_all_conditions

Set all spatial conditions.

set_condition

Set spatial conditions at a position.

get_condition

Get spatial conditions at a position.

remove_condition

Remove spatial conditions at a position.

boolean_operation

Get or set volume combined operation.

count

Return the spatial condition vector size.

Import detail#

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolConditionCombined

Property detail#

property SpatialAnalysisToolConditionCombined.boolean_operation: VolumeCombinedOperationType#

Get or set volume combined operation.

property SpatialAnalysisToolConditionCombined.count: int#

Return the spatial condition vector size.

Method detail#

SpatialAnalysisToolConditionCombined.get_all_conditions(self) list#

Get all spatial conditions.

Returns:

list

SpatialAnalysisToolConditionCombined.set_all_conditions(self, conditions: list) None#

Set all spatial conditions.

Parameters:

conditions : list

Returns:

None

SpatialAnalysisToolConditionCombined.set_condition(self, ref: ISpatialAnalysisToolVolume, pos: int) None#

Set spatial conditions at a position.

Parameters:

ref : ISpatialAnalysisToolVolume

pos : int

Returns:

None

SpatialAnalysisToolConditionCombined.get_condition(self, pos: int) ISpatialAnalysisToolVolume#

Get spatial conditions at a position.

Parameters:

pos : int

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionCombined.remove_condition(self, pos: int) None#

Remove spatial conditions at a position.

Parameters:

pos : int

Returns:

None