DataProviderResultInterval#

class ansys.stk.core.stkobjects.DataProviderResultInterval#: Represents a interval in the collection of intervals returned by the data providers.

Overview#

Methods

`threshold_crossings`	Return a two-dimensional array containing time and direction data (negative for decreasing). The DataSets property must contain the Time dataset for this method to work correctly.
`multiple_threshold_crossings`	Return an array of two-dimensional arrays. Each two-dimensional array contains start and stop times based on the boundaries passed in. The DataSets property must contain the Time dataset for this method to work correctly.

Properties

`start_time`	Return the start time of the interval. Uses DateFormat Dimension.
`stop_time`	Return the stop time of the interval. Uses DateFormat Dimension.
`data_sets`	Return a collection of data sets within the interval.

Import detail#

from ansys.stk.core.stkobjects import DataProviderResultInterval

Property detail#

property DataProviderResultInterval.start_time: Any#: Return the start time of the interval. Uses DateFormat Dimension.

property DataProviderResultInterval.stop_time: Any#: Return the stop time of the interval. Uses DateFormat Dimension.

property DataProviderResultInterval.data_sets: DataProviderResultDataSetCollection#: Return a collection of data sets within the interval.

Method detail#

DataProviderResultInterval.threshold_crossings(self, elem_name: str, threshold: Any) → list#

Return a two-dimensional array containing time and direction data (negative for decreasing). The DataSets property must contain the Time dataset for this method to work correctly.

Parameters:

elem_name : str

threshold : Any

Returns:

list

DataProviderResultInterval.multiple_threshold_crossings(self, elem_name: str, thresholds: list) → list#

Return an array of two-dimensional arrays. Each two-dimensional array contains start and stop times based on the boundaries passed in. The DataSets property must contain the Time dataset for this method to work correctly.

Parameters:

elem_name : str

thresholds : list

Returns:

list