CalculationToolConditionSetGroup#

class ansys.stk.core.analysis_workbench.CalculationToolConditionSetGroup#

Allow accessing and creating condition set components.

Overview#

remove

Remove a specified element.

contains

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

item

Return an element by name or at a specified position.

get_item_by_index

Retrieve a condition set from the collection by index.

get_item_by_name

Retrieve a condition set from the collection by name.

context

Return a context object. The context can be used to find out which central body or STK object this instance is associated with.

count

Return a number of elements in the group.

factory

Return a factory object used to create condition set components.

_new_enum

Return a COM enumerator.

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolConditionSetGroup

Property detail#

property CalculationToolConditionSetGroup.context: IAnalysisWorkbenchComponentContext#

Return a context object. The context can be used to find out which central body or STK object this instance is associated with.

property CalculationToolConditionSetGroup.count: int#

Return a number of elements in the group.

property CalculationToolConditionSetGroup.factory: CalculationToolConditionSetFactory#

Return a factory object used to create condition set components.

property CalculationToolConditionSetGroup._new_enum: EnumeratorProxy#

Return a COM enumerator.

Method detail#

CalculationToolConditionSetGroup.remove(self, event_name: str) None#

Remove a specified element.

Parameters:

event_name : str

Returns:

None

CalculationToolConditionSetGroup.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

CalculationToolConditionSetGroup.item(self, index_or_name: Any) ICalculationToolConditionSet#

Return an element by name or at a specified position.

Parameters:

index_or_name : Any

Returns:

ICalculationToolConditionSet

CalculationToolConditionSetGroup.get_item_by_index(self, index: int) ICalculationToolConditionSet#

Retrieve a condition set from the collection by index.

Parameters:

index : int

Returns:

ICalculationToolConditionSet

CalculationToolConditionSetGroup.get_item_by_name(self, name: str) ICalculationToolConditionSet#

Retrieve a condition set from the collection by name.

Parameters:

name : str

Returns:

ICalculationToolConditionSet