ProcedureTimeOptions

class ansys.stk.core.stkobjects.aviator.ProcedureTimeOptions

Class defining the time options for the current procedure.

Overview

Methods

set_start_time	Set the start time for the procedure.
set_interrupt_time	Set the interrupt time for the procedure.
set_stop_time	Set the stop time for the procedure.

Properties

start_time_enabled	Check to see if the start time is enabled for this procedure.
use_start_time	Opt whether to set a start time for the procedure.
start_time	Start time for the procedure.
interrupt_time_enabled	Check to see if the interrupt time is enabled for this procedure.
use_interrupt_time	Opt whether to set an interrupt time for the procedure.
interrupt_time	Interrupt time for the procedure.
stop_time_enabled	Check to see if the stop time is enabled for this procedure.
use_stop_time	Opt whether to set a stop time for the procedure.
stop_time	Stop time for the procedure.

Examples

Configure a procedure’s time options

# IProcedure procedure: Procedure object
# Get the time in epoch seconds
root.units_preferences.set_current_unit("DateFormat", "EpSec")
# Get the time options
timeOptions = procedure.time_options
# Get the start time
startTime = timeOptions.start_time
# Set the procedure to interrupt after 15 seconds
timeOptions.set_interrupt_time(15)

Import detail

from ansys.stk.core.stkobjects.aviator import ProcedureTimeOptions

Property detail

property ProcedureTimeOptions.start_time_enabled: bool

Check to see if the start time is enabled for this procedure.

property ProcedureTimeOptions.use_start_time: bool

Opt whether to set a start time for the procedure.

property ProcedureTimeOptions.start_time: Any

Start time for the procedure.

property ProcedureTimeOptions.interrupt_time_enabled: bool

Check to see if the interrupt time is enabled for this procedure.

property ProcedureTimeOptions.use_interrupt_time: bool

Opt whether to set an interrupt time for the procedure.

property ProcedureTimeOptions.interrupt_time: Any

Interrupt time for the procedure.

property ProcedureTimeOptions.stop_time_enabled: bool

Check to see if the stop time is enabled for this procedure.

property ProcedureTimeOptions.use_stop_time: bool

Opt whether to set a stop time for the procedure.

property ProcedureTimeOptions.stop_time: Any

Stop time for the procedure.

Method detail

ProcedureTimeOptions.set_start_time(self, time: Any) → None

Set the start time for the procedure.

Parameters:

time : Any

Returns:

None

ProcedureTimeOptions.set_interrupt_time(self, time: Any) → None

Set the interrupt time for the procedure.

Parameters:

time : Any

Returns:

None

ProcedureTimeOptions.set_stop_time(self, time: Any) → None

Set the stop time for the procedure.

Parameters:

time : Any

Returns:

None