IDataProvider

class ansys.stk.core.stkobjects.IDataProvider

Represents the Sub Data Provider (i.e. Fixed in Cartesian Position group on satellites, or Cartesian Position on facilities).

Overview

Methods

is_statistic_available	Is the supplied statistic available for the provided element name?
is_time_varying_extremum_available	Is the supplied time varying extremum available for the provided element name?

Properties

elements	Return a collection of elements associated with a DataProvider or a SubDataProvider.
pre_data	The string associated with the current PreData parameter.
allow_user_interface_for_pre_data	When set to true the data provider will display a user interface to select/enter the pre-data required.
is_valid	Return whether the data provider is valid.
pre_data_required	Return whether the data provider requires pre data.
pre_data_description	Return a description of the required pre data.

Import detail

from ansys.stk.core.stkobjects import IDataProvider

Property detail

property IDataProvider.elements: DataProviderElements

Return a collection of elements associated with a DataProvider or a SubDataProvider.

property IDataProvider.pre_data: str

The string associated with the current PreData parameter.

property IDataProvider.allow_user_interface_for_pre_data: bool

When set to true the data provider will display a user interface to select/enter the pre-data required.

property IDataProvider.is_valid: bool

Return whether the data provider is valid.

property IDataProvider.pre_data_required: bool

Return whether the data provider requires pre data.

property IDataProvider.pre_data_description: str

Return a description of the required pre data.

Method detail

IDataProvider.is_statistic_available(self, statistic: StatisticType, element_name: str) → bool

Is the supplied statistic available for the provided element name?

Parameters:

statistic : StatisticType

element_name : str

Returns:

bool

IDataProvider.is_time_varying_extremum_available(self, time_var_extremum: TimeVaryingExtremum, element_name: str) → bool

Is the supplied time varying extremum available for the provided element name?

Parameters:

time_var_extremum : TimeVaryingExtremum

element_name : str

Returns:

bool