TimeToolInstantSmartEpoch

class ansys.stk.core.analysis_workbench.TimeToolInstantSmartEpoch

Bases: ITimeToolInstant, IAnalysisWorkbenchComponent

A smart epoch.

Overview

Methods

set_explicit_time	Set explicit time instant and the smart epoch’s state to Explicit.
set_implicit_time	Set the reference event and the smart epoch’s state to Implicit.

Properties

time_instant	Represents the time instant if the state is set to explicit.
reference_epoch	A reference event object used to compute time instant if the state is set to implicit.
state	State of the event.

Import detail

from ansys.stk.core.analysis_workbench import TimeToolInstantSmartEpoch

Property detail

property TimeToolInstantSmartEpoch.time_instant: Any

Represents the time instant if the state is set to explicit.

property TimeToolInstantSmartEpoch.reference_epoch: ITimeToolInstant

A reference event object used to compute time instant if the state is set to implicit.

property TimeToolInstantSmartEpoch.state: SmartEpochState

State of the event.

Method detail

TimeToolInstantSmartEpoch.set_explicit_time(self, epoch: Any) → None

Set explicit time instant and the smart epoch’s state to Explicit.

Parameters:

epoch : Any

Returns:

None

TimeToolInstantSmartEpoch.set_implicit_time(self, event_epoch: ITimeToolInstant) → None

Set the reference event and the smart epoch’s state to Implicit.

Parameters:

event_epoch : ITimeToolInstant

Returns:

None