DataProviders

class ansys.stk.core.stkobjects.DataProviders

Class defining data providers.

Overview

Methods

item	Given an index, returns an element in the collection.
contains	Determine whether the collection contains a specific data provider.
get_item_by_index	Retrieve a data provider from the collection by index.
get_item_by_name	Retrieve a data provider from the collection by name.

Properties

count	Return an element in the collection.
_new_enum	Return an enumerator for the collection.

Import detail

from ansys.stk.core.stkobjects import DataProviders

Property detail

property DataProviders.count: int

Return an element in the collection.

property DataProviders._new_enum: EnumeratorProxy

Return an enumerator for the collection.

Method detail

DataProviders.item(self, index_or_name: Any) → IDataProviderInfo

Given an index, returns an element in the collection.

Parameters:

index_or_name : Any

Returns:

IDataProviderInfo

DataProviders.contains(self, data_provider_name: str) → bool

Determine whether the collection contains a specific data provider.

Parameters:

data_provider_name : str

Returns:

bool

DataProviders.get_item_by_index(self, index: int) → IDataProviderInfo

Retrieve a data provider from the collection by index.

Parameters:

index : int

Returns:

IDataProviderInfo

DataProviders.get_item_by_name(self, name: str) → IDataProviderInfo

Retrieve a data provider from the collection by name.

Parameters:

name : str

Returns:

IDataProviderInfo