TimeToolTimeIntervalCollectionGroup#

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalCollectionGroup#

Access or create VGT event interval collections associated with an object.

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 an event interval from the collection by index.

get_item_by_name

Retrieve an event interval 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 calc scalar components.

_new_enum

Return a COM enumerator.

Import detail#

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalCollectionGroup

Property detail#

property TimeToolTimeIntervalCollectionGroup.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 TimeToolTimeIntervalCollectionGroup.count: int#

Return a number of elements in the group.

property TimeToolTimeIntervalCollectionGroup.factory: TimeToolTimeIntervalCollectionFactory#

Return a factory object used to create calc scalar components.

property TimeToolTimeIntervalCollectionGroup._new_enum: EnumeratorProxy#

Return a COM enumerator.

Method detail#

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

Remove a specified element.

Parameters:

event_name : str

Returns:

None

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

TimeToolTimeIntervalCollectionGroup.item(self, index_or_name: Any) ITimeToolTimeIntervalCollection#

Return an element by name or at a specified position.

Parameters:

index_or_name : Any

Returns:

ITimeToolTimeIntervalCollection

TimeToolTimeIntervalCollectionGroup.get_item_by_index(self, index: int) ITimeToolTimeIntervalCollection#

Retrieve an event interval from the collection by index.

Parameters:

index : int

Returns:

ITimeToolTimeIntervalCollection

TimeToolTimeIntervalCollectionGroup.get_item_by_name(self, name: str) ITimeToolTimeIntervalCollection#

Retrieve an event interval from the collection by name.

Parameters:

name : str

Returns:

ITimeToolTimeIntervalCollection