ITimeToolInstant

class ansys.stk.core.analysis_workbench.ITimeToolInstant

Define an event (time instant).

Overview

Methods

find_occurrence	Return computed time instance if it occurs.
occurs_before	Return true if computed time instance occurs before or at specified time, return false otherwise.

Properties

type	Return the type of time instant.
today	Return time instant that corresponds to today’s GMT midnight.
tomorrow	Return time instant that corresponds to tomorrow’s GMT midnight.
noon_today	Return time instant that corresponds to today’s GMT noon.
noon_tomorrow	Return time instant that corresponds to tomorrow’s GMT noon.

Import detail

from ansys.stk.core.analysis_workbench import ITimeToolInstant

Property detail

property ITimeToolInstant.type: TimeEventType

Return the type of time instant.

property ITimeToolInstant.today: ITimeToolInstant

Return time instant that corresponds to today’s GMT midnight.

property ITimeToolInstant.tomorrow: ITimeToolInstant

Return time instant that corresponds to tomorrow’s GMT midnight.

property ITimeToolInstant.noon_today: ITimeToolInstant

Return time instant that corresponds to today’s GMT noon.

property ITimeToolInstant.noon_tomorrow: ITimeToolInstant

Return time instant that corresponds to tomorrow’s GMT noon.

Method detail

ITimeToolInstant.find_occurrence(self) → TimeToolInstantOccurrenceResult

Return computed time instance if it occurs.

Returns:

TimeToolInstantOccurrenceResult

ITimeToolInstant.occurs_before(self, epoch: Any) → bool

Return true if computed time instance occurs before or at specified time, return false otherwise.

Parameters:

epoch : Any

Returns:

bool