AnalysisWorkbenchComponentCollection

class ansys.stk.core.analysis_workbench.AnalysisWorkbenchComponentCollection

A collection of VGT objects.

Overview

Methods

contains	Search for a an element with a given name. Returns false if the specified element does not exist.
item	Retrieve an element of the collection using the name of the element or a position in the collection.
get_item_by_index	Retrieve an item from the crdn collection by index.
get_item_by_name	Retrieve an item from the crdn collection by name.

Properties

count	Return a number of elements in the collection.
_new_enum	Return a COM enumerator.

Import detail

from ansys.stk.core.analysis_workbench import AnalysisWorkbenchComponentCollection

Property detail

property AnalysisWorkbenchComponentCollection.count: int

Return a number of elements in the collection.

property AnalysisWorkbenchComponentCollection._new_enum: EnumeratorProxy

Return a COM enumerator.

Method detail

AnalysisWorkbenchComponentCollection.contains(self, name: str) → bool

Search for a an element with a given name. Returns false if the specified element does not exist.

Parameters:

name : str

Returns:

bool

AnalysisWorkbenchComponentCollection.item(self, index_or_name: Any) → IAnalysisWorkbenchComponent

Retrieve an element of the collection using the name of the element or a position in the collection.

Parameters:

index_or_name : Any

Returns:

IAnalysisWorkbenchComponent

AnalysisWorkbenchComponentCollection.get_item_by_index(self, index: int) → IAnalysisWorkbenchComponent

Retrieve an item from the crdn collection by index.

Parameters:

index : int

Returns:

IAnalysisWorkbenchComponent

AnalysisWorkbenchComponentCollection.get_item_by_name(self, name: str) → IAnalysisWorkbenchComponent

Retrieve an item from the crdn collection by name.

Parameters:

name : str

Returns:

IAnalysisWorkbenchComponent