SpatialAnalysisToolCalculationFactory

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolCalculationFactory

The factory is used to create instances of volume calcs.

Overview

Methods

is_type_supported	Return whether the specified type is supported.
create	Create and registers a volume calc using specified name and description.
create_altitude	Create and registers a altitude to location volume calc type using specified name and description.
create_angle_to_location	Create and registers a angle to location volume calc type using specified name and description.
create_from_file	Create and registers a file volume calc type using specified name and description.
create_from_calculation_scalar	Create and registers a scalar to location volume calc type using specified name and description.
create_solar_intensity	Create and registers a solar intensity volume calc type using specified name and description.
create_spatial_condition_satisfaction_metrics	Create and registers a spatial condition satisfaction metric volume calc type using specified name and description.
create_distance_to_location	Create and registers a distance to location volume calc type using specified name and description.
create_propagation_delay_to_location	Create and registers a distance to location volume calc type using specified name and description.

Import detail

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolCalculationFactory

Method detail

SpatialAnalysisToolCalculationFactory.is_type_supported(self, type: SpatialCalculationType) → bool

Return whether the specified type is supported.

Parameters:

type : SpatialCalculationType

Returns:

bool

SpatialAnalysisToolCalculationFactory.create(self, name: str, description: str, type: SpatialCalculationType) → ISpatialAnalysisToolSpatialCalculation

Create and registers a volume calc using specified name and description.

Parameters:

name : str

description : str

type : SpatialCalculationType

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_altitude(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a altitude to location volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_angle_to_location(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a angle to location volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_from_file(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a file volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_from_calculation_scalar(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a scalar to location volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_solar_intensity(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a solar intensity volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_spatial_condition_satisfaction_metrics(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a spatial condition satisfaction metric volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_distance_to_location(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a distance to location volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation

SpatialAnalysisToolCalculationFactory.create_propagation_delay_to_location(self, name: str, description: str) → ISpatialAnalysisToolSpatialCalculation

Create and registers a distance to location volume calc type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolSpatialCalculation