TimeToolTimeIntervalSmartInterval

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalSmartInterval

Bases: ITimeToolTimeInterval, IAnalysisWorkbenchComponent

A smart interval.

Overview

Methods

set_implicit_interval	Set the reference interval and changes the state to Implicit.
find_start_time	Find a start time of the interval. An exception is thrown if the start time cannot be determined from the interval’s current state.
find_stop_time	Find a stop time of the interval. An exception is thrown if the stop time cannot be determined from the interval’s current state.
get_start_epoch	Return a copy of the start epoch. Changes to the epoch will not affect the state of the interval.
set_start_epoch	Set a start of the interval using specified epoch component.
get_stop_epoch	Return a copy of the stop epoch. Changes to the epoch will not affect the state of the interval.
set_stop_epoch	Set a stop of the interval using specified epoch component.
set_explicit_interval	Set the interval’s start and the stop times changes the interval’s state to explicit. Exception is thrown if specified start time is greater than stop time.
set_start_and_stop_epochs	Set the interval’s start and stop epochs as two smart epoch components. Exception is thrown if specified start time is greater than stop time.
set_start_and_stop_times	Set the interval’s start and stop epochs as explicit times. Exception is thrown if specified start time is greater than stop time.
set_start_epoch_and_duration	Set the interval’s start epoch and the interval’s duration.
set_start_time_and_duration	Set the interval’s start time and the interval’s duration.

Properties

reference_interval	The reference interval used to compute start/stop times of this interval if the state of the interval is set to implicit.
duration_as_string	The duration of the interval.
state	A state of the smart interval.

Import detail

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalSmartInterval

Property detail

property TimeToolTimeIntervalSmartInterval.reference_interval: ITimeToolTimeInterval

The reference interval used to compute start/stop times of this interval if the state of the interval is set to implicit.

property TimeToolTimeIntervalSmartInterval.duration_as_string: str

The duration of the interval.

property TimeToolTimeIntervalSmartInterval.state: SmartIntervalState

A state of the smart interval.

Method detail

TimeToolTimeIntervalSmartInterval.set_implicit_interval(self, event_interval: ITimeToolTimeInterval) → None

Set the reference interval and changes the state to Implicit.

Parameters:

event_interval : ITimeToolTimeInterval

Returns:

None

TimeToolTimeIntervalSmartInterval.find_start_time(self) → Any

Find a start time of the interval. An exception is thrown if the start time cannot be determined from the interval’s current state.

Returns:

Any

TimeToolTimeIntervalSmartInterval.find_stop_time(self) → Any

Find a stop time of the interval. An exception is thrown if the stop time cannot be determined from the interval’s current state.

Returns:

Any

TimeToolTimeIntervalSmartInterval.get_start_epoch(self) → TimeToolInstantSmartEpoch

Return a copy of the start epoch. Changes to the epoch will not affect the state of the interval.

Returns:

TimeToolInstantSmartEpoch

TimeToolTimeIntervalSmartInterval.set_start_epoch(self, start_epoch: TimeToolInstantSmartEpoch) → None

Set a start of the interval using specified epoch component.

Parameters:

start_epoch : TimeToolInstantSmartEpoch

Returns:

None

TimeToolTimeIntervalSmartInterval.get_stop_epoch(self) → TimeToolInstantSmartEpoch

Return a copy of the stop epoch. Changes to the epoch will not affect the state of the interval.

Returns:

TimeToolInstantSmartEpoch

TimeToolTimeIntervalSmartInterval.set_stop_epoch(self, stop_epoch: TimeToolInstantSmartEpoch) → None

Set a stop of the interval using specified epoch component.

Parameters:

stop_epoch : TimeToolInstantSmartEpoch

Returns:

None

TimeToolTimeIntervalSmartInterval.set_explicit_interval(self, start: Any, stop: Any) → None

Set the interval’s start and the stop times changes the interval’s state to explicit. Exception is thrown if specified start time is greater than stop time.

Parameters:

start : Any

stop : Any

Returns:

None

TimeToolTimeIntervalSmartInterval.set_start_and_stop_epochs(self, ref_start_epoch: TimeToolInstantSmartEpoch, ref_stop_epoch: TimeToolInstantSmartEpoch) → None

Set the interval’s start and stop epochs as two smart epoch components. Exception is thrown if specified start time is greater than stop time.

Parameters:

ref_start_epoch : TimeToolInstantSmartEpoch

ref_stop_epoch : TimeToolInstantSmartEpoch

Returns:

None

TimeToolTimeIntervalSmartInterval.set_start_and_stop_times(self, start_time: Any, stop_time: Any) → None

Set the interval’s start and stop epochs as explicit times. Exception is thrown if specified start time is greater than stop time.

Parameters:

start_time : Any

stop_time : Any

Returns:

None

TimeToolTimeIntervalSmartInterval.set_start_epoch_and_duration(self, ref_start_epoch: TimeToolInstantSmartEpoch, duration_str: str) → None

Set the interval’s start epoch and the interval’s duration.

Parameters:

ref_start_epoch : TimeToolInstantSmartEpoch

duration_str : str

Returns:

None

TimeToolTimeIntervalSmartInterval.set_start_time_and_duration(self, epoch: Any, duration_str: str) → None

Set the interval’s start time and the interval’s duration.

Parameters:

epoch : Any

duration_str : str

Returns:

None