TimeToolTimeIntervalScaled#

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalScaled#

Bases: ITimeToolTimeInterval, IAnalysisWorkbenchComponent

Interval defined by scaling original interval using either absolute or relative scale. If resulting interval’s start becomes after its stop, the interval becomes undefined.

Overview#

original_interval

The original interval.

absolute_increment

The absolute increment value which creates a interval by expanding (or shortening if negative) the original interval by shifting its start/stop times equally by half of specified increment value.

relative_increment

The relative increment value from which absolute increment is obtained by multiplying relative value by interval duration…

use_absolute_increment

Specify whether to use absolute or relative increment.

Import detail#

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalScaled

Property detail#

property TimeToolTimeIntervalScaled.original_interval: ITimeToolTimeInterval#

The original interval.

property TimeToolTimeIntervalScaled.absolute_increment: float#

The absolute increment value which creates a interval by expanding (or shortening if negative) the original interval by shifting its start/stop times equally by half of specified increment value.

property TimeToolTimeIntervalScaled.relative_increment: float#

The relative increment value from which absolute increment is obtained by multiplying relative value by interval duration…

property TimeToolTimeIntervalScaled.use_absolute_increment: bool#

Specify whether to use absolute or relative increment.