CalculationToolScalarGroup#

class ansys.stk.core.analysis_workbench.CalculationToolScalarGroup#: Access or create VGT calculation scalars associated with an object or a central body.

Overview#

Methods

`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 an element from the collection by index.
`get_item_by_name`	Retrieve an element from the collection by name.

Properties

`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 calc scalar components.
`_new_enum`	Return a COM enumerator.

from ansys.stk.core.analysis_workbench import CalculationToolScalarGroup

property CalculationToolScalarGroup.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 CalculationToolScalarGroup.count: int#: Return a number of elements in the group.

property CalculationToolScalarGroup.factory: CalculationToolScalarFactory#: Return a factory object used to create calc scalar components.

property CalculationToolScalarGroup._new_enum: EnumeratorProxy#: Return a COM enumerator.

CalculationToolScalarGroup.remove(self, event_name: str) → None#

Remove a specified element.

CalculationToolScalarGroup.contains(self, name: str) → bool#

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

CalculationToolScalarGroup.item(self, index_or_name: Any) → ICalculationToolScalar#

Return an element by name or at a specified position.

CalculationToolScalarGroup.get_item_by_index(self, index: int) → ICalculationToolScalar#

Retrieve an element from the collection by index.

CalculationToolScalarGroup.get_item_by_name(self, name: str) → ICalculationToolScalar#

Retrieve an element from the collection by name.