AccessSampling

class ansys.stk.core.stkobjects.AccessSampling

Define properties and methods to configure the sampling strategy used in access computations.

Overview

Methods

is_type_supported	Get a value indicating whether the specified type can be used.
set_type	Set the type of sampling method.

Properties

strategy	Sampling method strategy.
supported_types	Return an array of valid choices.
type	Type of sampling method used.

Import detail

from ansys.stk.core.stkobjects import AccessSampling

Property detail

property AccessSampling.strategy: ISamplingMethodStrategy

Sampling method strategy.

property AccessSampling.supported_types: list

Return an array of valid choices.

property AccessSampling.type: SamplingMethod

Type of sampling method used.

Method detail

AccessSampling.is_type_supported(self, sampling_method: SamplingMethod) → bool

Get a value indicating whether the specified type can be used.

Parameters:

sampling_method : SamplingMethod

Returns:

bool

AccessSampling.set_type(self, sampling_method: SamplingMethod) → None

Set the type of sampling method.

Parameters:

sampling_method : SamplingMethod

Returns:

None