AnalysisConfigurationCollection#

class ansys.stk.core.stkrfchannelmodeler.AnalysisConfigurationCollection#: A collection of analysis configurations.

Overview#

Methods

`item`	Given an index, returns the element in the collection.
`remove_at`	Remove the analysis configuration at the supplied index.
`remove`	Remove the supplied analysis configuration.
`add_new`	Add and returns a new analysis configuration.
`add`	Add the supplied analysis configuration.
`remove_all`	Clear the collection.
`contains`	Determine if the collection contains an analysis configuration with the given name.
`find`	Find an analysis configuration by name. Returns Null if the configuration name does not exist in the collection.

Properties

`count`	Return the number of elements in the collection.
`_new_enum`	Return an enumerator for the collection.

from ansys.stk.core.stkrfchannelmodeler import AnalysisConfigurationCollection

property AnalysisConfigurationCollection.count: int#: Return the number of elements in the collection.

property AnalysisConfigurationCollection._new_enum: EnumeratorProxy#: Return an enumerator for the collection.

AnalysisConfigurationCollection.item(self, index: int) → AnalysisConfiguration#

Given an index, returns the element in the collection.

AnalysisConfigurationCollection.remove_at(self, index: int) → None#

Remove the analysis configuration at the supplied index.

AnalysisConfigurationCollection.remove(self, value: AnalysisConfiguration) → None#

Remove the supplied analysis configuration.

AnalysisConfigurationCollection.add_new(self, model_type: AnalysisConfigurationModelType, configuration_name: str) → AnalysisConfiguration#

Add and returns a new analysis configuration.

Parameters:

model_type : AnalysisConfigurationModelType

configuration_name : str

Returns:

AnalysisConfiguration

AnalysisConfigurationCollection.add(self, value: AnalysisConfiguration) → None#

Add the supplied analysis configuration.

AnalysisConfigurationCollection.remove_all(self) → None#

Clear the collection.

AnalysisConfigurationCollection.contains(self, configuration_name: str) → bool#

Determine if the collection contains an analysis configuration with the given name.

AnalysisConfigurationCollection.find(self, configuration_name: str) → AnalysisConfiguration#

Find an analysis configuration by name. Returns Null if the configuration name does not exist in the collection.