ITimeToolTimeIntervalCollection

class ansys.stk.core.analysis_workbench.ITimeToolTimeIntervalCollection

A collection of related interval lists.

Overview

Methods

find_interval_collection	Return computed collection of interval lists.
occurred	Determine if specified time falls within any of the computed interval lists in the collection.

Properties

type	Return the type of collection of interval lists.
labels	Get the labels associated with the interval lists in the collection.

Import detail

from ansys.stk.core.analysis_workbench import ITimeToolTimeIntervalCollection

Property detail

property ITimeToolTimeIntervalCollection.type: EventIntervalCollectionType

Return the type of collection of interval lists.

property ITimeToolTimeIntervalCollection.labels: list

Get the labels associated with the interval lists in the collection.

Method detail

ITimeToolTimeIntervalCollection.find_interval_collection(self) → TimeToolIntervalsVectorResult

Return computed collection of interval lists.

Returns:

TimeToolIntervalsVectorResult

ITimeToolTimeIntervalCollection.occurred(self, epoch: Any) → TimeToolTimeIntervalCollectionOccurredResult

Determine if specified time falls within any of the computed interval lists in the collection.

Parameters:

epoch : Any

Returns:

TimeToolTimeIntervalCollectionOccurredResult