TimeToolTimeArrayGroup#

class ansys.stk.core.analysis_workbench.TimeToolTimeArrayGroup#: Access or create VGT event arrays associated with an object.

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 event array from the collection by index.
`get_item_by_name`	Retrieve an event array 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 event arrays.
`_new_enum`	Return a COM enumerator.

from ansys.stk.core.analysis_workbench import TimeToolTimeArrayGroup

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

property TimeToolTimeArrayGroup.factory: TimeToolTimeArrayFactory#: Return a Factory object used to create event arrays.

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

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

Remove a specified element.

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

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

TimeToolTimeArrayGroup.item(self, index_or_name: Any) → ITimeToolTimeArray#

Return an element by name or at a specified position.

TimeToolTimeArrayGroup.get_item_by_index(self, index: int) → ITimeToolTimeArray#

Retrieve an event array from the collection by index.

TimeToolTimeArrayGroup.get_item_by_name(self, name: str) → ITimeToolTimeArray#

Retrieve an event array from the collection by name.