DataProviderInterval

class ansys.stk.core.stkobjects.DataProviderInterval

Bases: IDataProvider, IDataProviderInfo

Support for interval data providers (e.g. Facility lighting times).

Overview

Methods

execute	Compute the data; interval data providers require an interval or list of intervals. StartTime/StopTime use DateFormat Dimension.
execute_elements	Compute the data and return just the indicated data elements; interval data providers require an interval or list of intervals. StartTime/StopTime use DateFormat Dimension.
execute_event_array	Compute the data given a Times Array component. Also requires object start and stop times, which use DateFormat Dimension.
execute_elements_event_array	Compute the data and returns just the indicated data elements; Input is a Times Array component, and object start and stop times. Start/Stop use DateFormat Dimension.

Import detail

from ansys.stk.core.stkobjects import DataProviderInterval

Method detail

DataProviderInterval.execute(self, start_time: Any, stop_time: Any) → DataProviderResult

Compute the data; interval data providers require an interval or list of intervals. StartTime/StopTime use DateFormat Dimension.

Parameters:

start_time : Any

stop_time : Any

Returns:

DataProviderResult

DataProviderInterval.execute_elements(self, start_time: Any, stop_time: Any, element_names: list) → DataProviderResult

Compute the data and return just the indicated data elements; interval data providers require an interval or list of intervals. StartTime/StopTime use DateFormat Dimension.

Parameters:

start_time : Any

stop_time : Any

element_names : list

Returns:

DataProviderResult

DataProviderInterval.execute_event_array(self, event_array: ITimeToolTimeArray, start_time: Any, stop_time: Any) → DataProviderResult

Compute the data given a Times Array component. Also requires object start and stop times, which use DateFormat Dimension.

Parameters:

event_array : ITimeToolTimeArray

start_time : Any

stop_time : Any

Returns:

DataProviderResult

DataProviderInterval.execute_elements_event_array(self, event_array: ITimeToolTimeArray, start_time: Any, stop_time: Any, element_names: list) → DataProviderResult

Compute the data and returns just the indicated data elements; Input is a Times Array component, and object start and stop times. Start/Stop use DateFormat Dimension.

Parameters:

event_array : ITimeToolTimeArray

start_time : Any

stop_time : Any

element_names : list

Returns:

DataProviderResult