TimeToolTimeArrayFactory

class ansys.stk.core.analysis_workbench.TimeToolTimeArrayFactory

The factory creates event arrays.

Overview

Methods

create	Create and register an event array using specified name, description, and type.
create_extrema	Create an event array by determining times of local minimum and/or maximum of specified scalar calculation.
create_start_stop_times	Create an event array by taking start and/or stop times of every interval in the specified reference interval list and adding them to array.
create_merged	Create an event array by merging times from two other arrays by creating a union of bounding intervals from two constituent arrays.
create_filtered	Create an event array by filtering times from an original time array according to specified filtering method.
create_fixed_step	Create an event array using fixed time steps from the specified time reference and adding sampled times to array if they fall within specified bounding interval list.
create_condition_crossings	Create an event array containing times at which the specified condition will change its satisfaction status.
create_signaled	Create an event array recorded at target clock location by performing signal transmission of original time array between base and target clock locations.
is_type_supported	Return whether the specified type is supported.
create_fixed_times	Create an event array using specified times.

Import detail

from ansys.stk.core.analysis_workbench import TimeToolTimeArrayFactory

Method detail

TimeToolTimeArrayFactory.create(self, name: str, description: str, type: EventArrayType) → ITimeToolTimeArray

Create and register an event array using specified name, description, and type.

Parameters:

name : str

description : str

type : EventArrayType

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_extrema(self, name: str, description: str) → ITimeToolTimeArray

Create an event array by determining times of local minimum and/or maximum of specified scalar calculation.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_start_stop_times(self, name: str, description: str) → ITimeToolTimeArray

Create an event array by taking start and/or stop times of every interval in the specified reference interval list and adding them to array.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_merged(self, name: str, description: str) → ITimeToolTimeArray

Create an event array by merging times from two other arrays by creating a union of bounding intervals from two constituent arrays.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_filtered(self, name: str, description: str) → ITimeToolTimeArray

Create an event array by filtering times from an original time array according to specified filtering method.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_fixed_step(self, name: str, description: str) → ITimeToolTimeArray

Create an event array using fixed time steps from the specified time reference and adding sampled times to array if they fall within specified bounding interval list.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_condition_crossings(self, name: str, description: str) → ITimeToolTimeArray

Create an event array containing times at which the specified condition will change its satisfaction status.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.create_signaled(self, name: str, description: str) → ITimeToolTimeArray

Create an event array recorded at target clock location by performing signal transmission of original time array between base and target clock locations.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray

TimeToolTimeArrayFactory.is_type_supported(self, type: EventArrayType) → bool

Return whether the specified type is supported.

Parameters:

type : EventArrayType

Returns:

bool

TimeToolTimeArrayFactory.create_fixed_times(self, name: str, description: str) → ITimeToolTimeArray

Create an event array using specified times.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeArray