IProcedure#

class ansys.stk.core.stkobjects.aviator.IProcedure#: Interface used to access the options for a procedure. Use this interface to get the Site and Get the time options for the current procedure.

Overview#

Properties

`name`	Get or set the name of the procedure.
`site`	Get the site of the current procedure.
`time_options`	Get the time options for the current procedure.
`wind_model`	Get the wind model for the current procedure.
`atmosphere_model`	Get the mission atmosphere model.
`calculation_options`	Get the calculation options for the current procedure.
`refuel_dump_is_supported`	Refuel/dump is supported for the current procedure.
`refuel_dump_properties`	Get the refuel/dump properties for the current procedure.
`fast_time_options`	Get the fast time options (without validation or constraints) for the current procedure.

Examples#

Configure the wind and atmosphere for a procedure

# IProcedure procedure: Procedure object
# Get the wind model for the procedure
windModel = procedure.wind_model
# Use the procedure model
windModel.wind_model_source = WindAtmosphereModelSource.PROCEDURE_MODEL
# Let's use constant wind
windModel.wind_model_type = WindModelType.CONSTANT_WIND
# Get the constant wind model options
constantWind = windModel.mode_as_constant
# Set the wind bearing
constantWind.wind_bearing = 30
# Set the wind speed
constantWind.wind_speed = 5

# Get the atmosphere model used for the procedure
atmosphere = procedure.atmosphere_model
# Let's use the procedure model
atmosphere.atmosphere_model_source = WindAtmosphereModelSource.PROCEDURE_MODEL
# Get the basic atmosphere options
basicAtmosphere = atmosphere.mode_as_basic
# Use standard 1976 atmosphere
basicAtmosphere.basic_model_type = AtmosphereModelType.STANDARD1976

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)

Rename a procedure and its site

# IProcedure procedure: Procedure object
# Rename the procedure
procedure.name = "New Procedure"
# Get the site corresponding to the procedure
site = procedure.site
# Rename the site
site.name = "New Site"

Import detail#

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

Property detail#

property IProcedure.name: str#: Get or set the name of the procedure.

property IProcedure.site: ISite#: Get the site of the current procedure.

property IProcedure.time_options: ProcedureTimeOptions#: Get the time options for the current procedure.

property IProcedure.wind_model: WindModel#: Get the wind model for the current procedure.

property IProcedure.atmosphere_model: AtmosphereModel#: Get the mission atmosphere model.

property IProcedure.calculation_options: CalculationOptions#: Get the calculation options for the current procedure.

property IProcedure.refuel_dump_is_supported: bool#: Refuel/dump is supported for the current procedure.

property IProcedure.refuel_dump_properties: RefuelDumpProperties#: Get the refuel/dump properties for the current procedure.

property IProcedure.fast_time_options: ProcedureFastTimeOptions#: Get the fast time options (without validation or constraints) for the current procedure.