DataProviderTimeVarying

class ansys.stk.core.stkobjects.DataProviderTimeVarying

Bases: IDataProvider, IDataProviderInfo

Support for time-dependent data providers (e.g. Satellite position).

Overview

Methods

execute	Compute the data; time-dependent data providers require an interval and a time step. Start/Stop use DateFormat Dimension. StepTime uses Time Dimension.
execute_elements	Compute the data and return just the indicated data elements; time-dependent data providers require an interval and a time step.
execute_single	Compute the data given a single Time. SingleTime uses DateFormat Dimension.
execute_single_elements	Compute the data given a single Time and return just the indicated data elements. SingleTime uses DateFormat Dimension.
execute_single_elements_array	Compute the data given a single Time array and return just the indicated data elements. If time values without data are requested, null entries will be returned in the data array. SingleTime uses DateFormat Dimension.
execute_native_times	Compute the data for default; default time-dependent data providers require an interval. Start/Stop use DateFormat Dimension.
execute_elements_native_times	Compute the data for default; return just the indicated data elements; default time-dependent data providers require an interval. Start/Stop 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.
execute_elements_event_array_only	Compute the data and returns just the indicated data elements; Input is a Times Array component.

Import detail

from ansys.stk.core.stkobjects import DataProviderTimeVarying

Method detail

DataProviderTimeVarying.execute(self, start_time: Any, stop_time: Any, step_time: float) → DataProviderResult

Compute the data; time-dependent data providers require an interval and a time step. Start/Stop use DateFormat Dimension. StepTime uses Time Dimension.

Parameters:

start_time : Any

stop_time : Any

step_time : float

Returns:

DataProviderResult

DataProviderTimeVarying.execute_elements(self, start_time: Any, stop_time: Any, step_time: float, element_names: list) → DataProviderResult

Compute the data and return just the indicated data elements; time-dependent data providers require an interval and a time step.

Parameters:

start_time : Any

stop_time : Any

step_time : float

element_names : list

Returns:

DataProviderResult

DataProviderTimeVarying.execute_single(self, single_time: Any) → DataProviderResult

Compute the data given a single Time. SingleTime uses DateFormat Dimension.

Parameters:

single_time : Any

Returns:

DataProviderResult

DataProviderTimeVarying.execute_single_elements(self, single_time: Any, element_names: list) → DataProviderResult

Compute the data given a single Time and return just the indicated data elements. SingleTime uses DateFormat Dimension.

Parameters:

single_time : Any

element_names : list

Returns:

DataProviderResult

DataProviderTimeVarying.execute_single_elements_array(self, time_array: list, element_names: list) → DataProviderResultTimeArrayElements

Compute the data given a single Time array and return just the indicated data elements. If time values without data are requested, null entries will be returned in the data array. SingleTime uses DateFormat Dimension.

Parameters:

time_array : list

element_names : list

Returns:

DataProviderResultTimeArrayElements

DataProviderTimeVarying.execute_native_times(self, start_time: Any, stop_time: Any) → DataProviderResult

Compute the data for default; default time-dependent data providers require an interval. Start/Stop use DateFormat Dimension.

Parameters:

start_time : Any

stop_time : Any

Returns:

DataProviderResult

DataProviderTimeVarying.execute_elements_native_times(self, start_time: Any, stop_time: Any, element_names: list) → DataProviderResult

Compute the data for default; return just the indicated data elements; default time-dependent data providers require an interval. Start/Stop use DateFormat Dimension.

Parameters:

start_time : Any

stop_time : Any

element_names : list

Returns:

DataProviderResult

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

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

DataProviderTimeVarying.execute_elements_event_array_only(self, event_array: ITimeToolTimeArray, element_names: list) → DataProviderResult

Compute the data and returns just the indicated data elements; Input is a Times Array component.

Parameters:

event_array : ITimeToolTimeArray

element_names : list

Returns:

DataProviderResult