TimeToolTimeIntervalFactory

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalFactory

The factory creates event intervals.

Overview

Methods

create	Create and register an interval using specified name, description, and type.
create_fixed	Create an interval defined between two explicitly specified start and stop times.
create_fixed_duration	Create an interval of fixed duration specified using start and stop offsets relative to specified reference time instant.
create_between_time_instants	Create an interval using specified start and stop time instants.
create_from_interval_list	Create an interval from a specified interval list by using one of several selection methods.
create_scaled	Create an interval by scaling an original interval using either absolute or relative scale.
create_signaled	Create an interval that is recorded at target clock location by performing signal transmission of original interval between base and target clock locations.
create_time_offset	Create an interval defined by shifting the specified reference interval by a fixed time offset.
is_type_supported	Return whether the specified type is supported.

Import detail

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalFactory

Method detail

TimeToolTimeIntervalFactory.create(self, name: str, description: str, type: EventIntervalType) → ITimeToolTimeInterval

Create and register an interval using specified name, description, and type.

Parameters:

name : str

description : str

type : EventIntervalType

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_fixed(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval defined between two explicitly specified start and stop times.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_fixed_duration(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval of fixed duration specified using start and stop offsets relative to specified reference time instant.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_between_time_instants(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval using specified start and stop time instants.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_from_interval_list(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval from a specified interval list by using one of several selection methods.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_scaled(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval by scaling an original interval using either absolute or relative scale.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_signaled(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval that is recorded at target clock location by performing signal transmission of original interval between base and target clock locations.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.create_time_offset(self, name: str, description: str) → ITimeToolTimeInterval

Create an interval defined by shifting the specified reference interval by a fixed time offset.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeInterval

TimeToolTimeIntervalFactory.is_type_supported(self, type: EventIntervalType) → bool

Return whether the specified type is supported.

Parameters:

type : EventIntervalType

Returns:

bool