ITimeToolTimeInterval#

class ansys.stk.core.analysis_workbench.ITimeToolTimeInterval#

A single time interval.

Overview#

find_interval

Return computed interval if it exists.

occurred

Determine if specified time falls within computed interval if it exists.

type

Return the type of interval.

label_start_description

The start description.

label_stop_description

The stop description.

label_start

A label associated with the interval start.

label_stop

A label associated with the interval stop.

Import detail#

from ansys.stk.core.analysis_workbench import ITimeToolTimeInterval

Property detail#

property ITimeToolTimeInterval.type: EventIntervalType#

Return the type of interval.

property ITimeToolTimeInterval.label_start_description: str#

The start description.

property ITimeToolTimeInterval.label_stop_description: str#

The stop description.

property ITimeToolTimeInterval.label_start: str#

A label associated with the interval start.

property ITimeToolTimeInterval.label_stop: str#

A label associated with the interval stop.

Method detail#

ITimeToolTimeInterval.find_interval(self) TimeToolTimeIntervalResult#

Return computed interval if it exists.

Returns:

TimeToolTimeIntervalResult

ITimeToolTimeInterval.occurred(self, epoch: Any) bool#

Determine if specified time falls within computed interval if it exists.

Parameters:

epoch : Any

Returns:

bool