TimeToolInstantFactory

class ansys.stk.core.analysis_workbench.TimeToolInstantFactory

The factory creates events.

Overview

Methods

create	Create and registers an event using specified name, description, and type.
create_epoch	Create an event set at a specified date/time.
create_extremum	Create an event that determines the time of global minimum or maximum of specified scalar calculation.
create_start_stop_time	Create an event that is either the start or stop time selected from a reference interval.
create_signaled	Create an event recorded on a specified clock via signal transmission from an original time instant recorded on different clock.
create_time_offset	Create an event at fixed offset from specified reference event.
create_smart_epoch_from_time	Create a smart epoch from STK epoch.
create_smart_epoch_from_event	Create a smart epoch from an event.
is_type_supported	Return whether the specified type is supported.

Properties

today	Return Today time instant.
tomorrow	Return Tomorrow time instant.

Import detail

from ansys.stk.core.analysis_workbench import TimeToolInstantFactory

Property detail

property TimeToolInstantFactory.today: ITimeToolInstant

Return Today time instant.

property TimeToolInstantFactory.tomorrow: ITimeToolInstant

Return Tomorrow time instant.

Method detail

TimeToolInstantFactory.create(self, name: str, description: str, type: TimeEventType) → ITimeToolInstant

Create and registers an event using specified name, description, and type.

Parameters:

name : str

description : str

type : TimeEventType

Returns:

ITimeToolInstant

TimeToolInstantFactory.create_epoch(self, name: str, description: str) → ITimeToolInstant

Create an event set at a specified date/time.

Parameters:

name : str

description : str

Returns:

ITimeToolInstant

TimeToolInstantFactory.create_extremum(self, name: str, description: str) → ITimeToolInstant

Create an event that determines the time of global minimum or maximum of specified scalar calculation.

Parameters:

name : str

description : str

Returns:

ITimeToolInstant

TimeToolInstantFactory.create_start_stop_time(self, name: str, description: str) → ITimeToolInstant

Create an event that is either the start or stop time selected from a reference interval.

Parameters:

name : str

description : str

Returns:

ITimeToolInstant

TimeToolInstantFactory.create_signaled(self, name: str, description: str) → ITimeToolInstant

Create an event recorded on a specified clock via signal transmission from an original time instant recorded on different clock.

Parameters:

name : str

description : str

Returns:

ITimeToolInstant

TimeToolInstantFactory.create_time_offset(self, name: str, description: str) → ITimeToolInstant

Create an event at fixed offset from specified reference event.

Parameters:

name : str

description : str

Returns:

ITimeToolInstant

TimeToolInstantFactory.create_smart_epoch_from_time(self, epoch: Any) → TimeToolInstantSmartEpoch

Create a smart epoch from STK epoch.

Parameters:

epoch : Any

Returns:

TimeToolInstantSmartEpoch

TimeToolInstantFactory.create_smart_epoch_from_event(self, ref_event: ITimeToolInstant) → TimeToolInstantSmartEpoch

Create a smart epoch from an event.

Parameters:

ref_event : ITimeToolInstant

Returns:

TimeToolInstantSmartEpoch

TimeToolInstantFactory.is_type_supported(self, type: TimeEventType) → bool

Return whether the specified type is supported.

Parameters:

type : TimeEventType

Returns:

bool