SpatialAnalysisToolConditionFactory

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolConditionFactory

The factory is used to create instances of volumes.

Overview

Methods

create	Create and registers a volume using specified name and description.
is_type_supported	Return whether the specified type is supported.
create_combined	Create a volume type combined.
create_lighting	Create a volume type lighting.
create_volume_over_time	Create a volume type over time.
create_from_grid	Create a volume type from grid.
create_from_spatial_calculation	Create a volume type from calc.
create_from_time_satisfaction	Create a volume type from time satisfaction.
create_from_condition	Create a volume type condition.
create_from_access	Create a volume type Inview.

Import detail

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolConditionFactory

Method detail

SpatialAnalysisToolConditionFactory.create(self, name: str, description: str, type: VolumeType) → ISpatialAnalysisToolVolume

Create and registers a volume using specified name and description.

Parameters:

name : str

description : str

type : VolumeType

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.is_type_supported(self, type: VolumeType) → bool

Return whether the specified type is supported.

Parameters:

type : VolumeType

Returns:

bool

SpatialAnalysisToolConditionFactory.create_combined(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type combined.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_lighting(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type lighting.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_volume_over_time(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type over time.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_from_grid(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type from grid.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_from_spatial_calculation(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type from calc.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_from_time_satisfaction(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type from time satisfaction.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_from_condition(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type condition.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume

SpatialAnalysisToolConditionFactory.create_from_access(self, name: str, description: str) → ISpatialAnalysisToolVolume

Create a volume type Inview.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolume