TimeToolTimeIntervalGroup#

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

Overview#

Methods

`remove`	Remove an element by name.
`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 interval from the collection by index.
`get_item_by_name`	Retrieve an event interval 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 custom event intervals.
`_new_enum`	Return a COM enumerator.

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalGroup

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

property TimeToolTimeIntervalGroup.factory: TimeToolTimeIntervalFactory#: Return a Factory object used to create custom event intervals.

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

TimeToolTimeIntervalGroup.remove(self, event_interval_name: str) → None#

Remove an element by name.

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

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

TimeToolTimeIntervalGroup.item(self, index_or_name: Any) → ITimeToolTimeInterval#

Return an element by name or at a specified position.

TimeToolTimeIntervalGroup.get_item_by_index(self, index: int) → ITimeToolTimeInterval#

Retrieve an event interval from the collection by index.

TimeToolTimeIntervalGroup.get_item_by_name(self, name: str) → ITimeToolTimeInterval#

Retrieve an event interval from the collection by name.