Scenario

class ansys.stk.core.stkobjects.Scenario

Bases: ISTKObject, ILifetimeInformation

Class defining the Scenario object.

Overview

Methods

set_time_period	Set the Scenario time period. startTime/stopTime use DateFormat Dimension.
set_dirty	Set the flag indicating the scenario has been modified.
get_existing_accesses	Return an array of existing accesses in the current scenario. The result is a two-dimensional array of triplets where each triplet contains the paths of two objects participating in the access and a flag indicating whether the access is computed.
get_access_between_objects_by_path	Return an Access object associated with the two STK objects specified using their paths. The paths can be fully-qualified or truncated.

Properties

start_time	Scenario start time. Uses DateFormat Dimension.
stop_time	Scenario stop time. Uses DateFormat Dimension.
epoch	Scenario epoch. Uses DateFormat Dimension.
animation_settings	Scenario animation settings.
earth_data	Scenario Earth Data settings.
graphics	Scenario 2D Graphics settings.
database_settings	Scenario database settings.
display_warning_if_orbit_impacts_ground	Specify whether to display a warning when a satellite orbit intersects the central body.
show_warning_if_missile_fails_to_impact	Specify whether to display a warning when a missile trajectory does not impact the central body.
graphics_3d	Scenario 3D Graphics settings.
aircraft_wgs84_warning	Specify when to display the aircraft mission modeler WGS84 warning.
show_warning_whether_missile_achieves_orbit_or_not	Generate a message that warns the user if the missile achieves orbit (and give the perigee) or impacts the surface (and give the interval after missile’s stop time).
terrain	Return a list of central bodies and their terrains.
component_directory	Get the component directory interface.
scenario_files	Return list of scenario files.
is_dirty	Specify whether scenario needs to be saved.
use_analysis_start_time_for_epoch	Whether the scenario Epoch is the same as the scenario’s StartTime.
space_environment	Scenario SpaceEnvironment settings.
scene_manager	A scene manager.
analysis_interval	Allow the user to configure the scenario’s analysis time period.
analysis_epoch	Allow the user to configure the scenario’s analysis epoch.
radar_clutter_map	Return the global radar clutter map.
radar_cross_section	Return the global radar cross section.
rf_environment	Return the RF environment.
tilesets	Return a list of 3D Tilesets used for Analysis.
laser_environment	Return the laser environment.

Examples

Set the current scenario’s time period

# STKObjectRoot root: STK Object Model Root
scenario = root.current_scenario
scenario.set_time_period(start_time="1 Jan 2012 12:00:00.000", stop_time="2 Jan 2012 12:00:00.000")

Import detail

from ansys.stk.core.stkobjects import Scenario

Property detail

property Scenario.start_time: Any

Scenario start time. Uses DateFormat Dimension.

property Scenario.stop_time: Any

Scenario stop time. Uses DateFormat Dimension.

property Scenario.epoch: Any

Scenario epoch. Uses DateFormat Dimension.

property Scenario.animation_settings: ScenarioAnimation

Scenario animation settings.

property Scenario.earth_data: ScenarioEarthData

Scenario Earth Data settings.

property Scenario.graphics: ScenarioGraphics

Scenario 2D Graphics settings.

property Scenario.database_settings: ScenarioDatabaseCollection

Scenario database settings.

property Scenario.display_warning_if_orbit_impacts_ground: bool

Specify whether to display a warning when a satellite orbit intersects the central body.

property Scenario.show_warning_if_missile_fails_to_impact: bool

Specify whether to display a warning when a missile trajectory does not impact the central body.

property Scenario.graphics_3d: ScenarioGraphics3D

Scenario 3D Graphics settings.

property Scenario.aircraft_wgs84_warning: AircraftWGS84WarningType

Specify when to display the aircraft mission modeler WGS84 warning.

property Scenario.show_warning_whether_missile_achieves_orbit_or_not: bool

Generate a message that warns the user if the missile achieves orbit (and give the perigee) or impacts the surface (and give the interval after missile’s stop time).

property Scenario.terrain: CentralBodyTerrainCollection

Return a list of central bodies and their terrains.

property Scenario.component_directory: ComponentDirectory

Get the component directory interface.

property Scenario.scenario_files: list

Return list of scenario files.

property Scenario.is_dirty: bool

Specify whether scenario needs to be saved.

property Scenario.use_analysis_start_time_for_epoch: bool

Whether the scenario Epoch is the same as the scenario’s StartTime.

property Scenario.space_environment: ScenarioSpaceEnvironment

Scenario SpaceEnvironment settings.

property Scenario.scene_manager: ISceneManager

A scene manager.

property Scenario.analysis_interval: ITimeToolTimeIntervalSmartInterval

Allow the user to configure the scenario’s analysis time period.

property Scenario.analysis_epoch: ITimeToolInstantSmartEpoch

Allow the user to configure the scenario’s analysis epoch.

property Scenario.radar_clutter_map: IRadarClutterMap

Return the global radar clutter map.

property Scenario.radar_cross_section: RadarCrossSection

Return the global radar cross section.

property Scenario.rf_environment: RFEnvironment

Return the RF environment.

property Scenario.tilesets: Tileset3DCollection

Return a list of 3D Tilesets used for Analysis.

property Scenario.laser_environment: LaserEnvironment

Return the laser environment.

Method detail

Scenario.set_time_period(self, start_time: Any, stop_time: Any) → None

Set the Scenario time period. startTime/stopTime use DateFormat Dimension.

Parameters:

start_time : Any

stop_time : Any

Returns:

None

Examples

Set the current scenario’s time period

# STKObjectRoot root: STK Object Model Root
scenario = root.current_scenario
scenario.set_time_period(start_time="1 Jan 2012 12:00:00.000", stop_time="2 Jan 2012 12:00:00.000")

Scenario.set_dirty(self) → None

Set the flag indicating the scenario has been modified.

Returns:

None

Scenario.get_existing_accesses(self) → list

Return an array of existing accesses in the current scenario. The result is a two-dimensional array of triplets where each triplet contains the paths of two objects participating in the access and a flag indicating whether the access is computed.

Returns:

list

Scenario.get_access_between_objects_by_path(self, object_path1: str, object_path2: str) → Access

Return an Access object associated with the two STK objects specified using their paths. The paths can be fully-qualified or truncated.

Parameters:

object_path1 : str

object_path2 : str

Returns:

Access