SpatialAnalysisToolGridCoordinateDefinition

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition

Define a set of coordinate values.

Overview

Methods

set_fixed_step	Set grid values type to fixed step.
set_grid_values_fixed_number_of_steps	Do not use this method, as it is deprecated. Use SetGridValuesFixedNumberOfStepsEx.
set_custom	Set grid values type to custom values.
set_fixed_number_of_steps	Set grid values type to fixed number of steps with min and max as Quantity.

Properties

method_type	Grid values method type.
grid_values_method	Get or set the grid values interface.

Import detail

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolGridCoordinateDefinition

Property detail

property SpatialAnalysisToolGridCoordinateDefinition.method_type: GridValuesMethodType

Grid values method type.

property SpatialAnalysisToolGridCoordinateDefinition.grid_values_method: ISpatialAnalysisToolGridValuesMethod

Get or set the grid values interface.

Method detail

SpatialAnalysisToolGridCoordinateDefinition.set_fixed_step(self, min: float, max: float, include_min_max: bool, ref_value: float, fixed_step: float) → SpatialAnalysisToolGridValuesFixedStep

Set grid values type to fixed step.

Parameters:

min : float

max : float

include_min_max : bool

ref_value : float

fixed_step : float

Returns:

SpatialAnalysisToolGridValuesFixedStep

SpatialAnalysisToolGridCoordinateDefinition.set_grid_values_fixed_number_of_steps(self, min: float, max: float, num_steps: int) → SpatialAnalysisToolGridValuesFixedNumberOfSteps

Do not use this method, as it is deprecated. Use SetGridValuesFixedNumberOfStepsEx.

Parameters:

min : float

max : float

num_steps : int

Returns:

SpatialAnalysisToolGridValuesFixedNumberOfSteps

SpatialAnalysisToolGridCoordinateDefinition.set_custom(self, values: list) → SpatialAnalysisToolGridValuesCustom

Set grid values type to custom values.

Parameters:

values : list

Returns:

SpatialAnalysisToolGridValuesCustom

SpatialAnalysisToolGridCoordinateDefinition.set_fixed_number_of_steps(self, min: Quantity, max: Quantity, num_steps: int) → SpatialAnalysisToolGridValuesFixedNumberOfSteps

Set grid values type to fixed number of steps with min and max as Quantity.

Parameters:

min : Quantity

max : Quantity

num_steps : int

Returns:

SpatialAnalysisToolGridValuesFixedNumberOfSteps