Description | Example | Return Message | Group

Environment

Control the use of environmental models in a scenario

Syntax

Environment <ScenarioPath> SetValue <AttributePath> <Value> [<Unit>]

Related Commands

Description

The Environment command allows you to specify the value(s) of specific environmental models as pointed to by a specific attribute. The environmental models include models for rain fade and gaseous absorption.

The Environment commands are applied at the scenario level.

Parameter Description
<AttributePath> Specify the path the attribute being changed.
<Value> The specified attribute will be set to this value.
<Unit> When entering a numeric value include the <Unit> to specify the abbreviation of the unit that the numeric value is being entered in. If not included then the <Value> is assumed to be in the internal units.

Use this command in conjunction with the Environment_RM GetValue command, which will return a list of attributes, or the properties and choices for a specific attribute.

Example

Set the UseCloudFogModel attribute to true, and set the ceiling, water density and temperature:

Environment * SetValue PropagationChannel.UseCloudFogModel true
Environment * SetValue PropagationChannel.CloudFogModel.CloudCeiling 8000
Environment * SetValue PropagationChannel.CloudFogModel.CloudLiqWaterDensity 456.0 kg/km^3
Environment * SetValue PropagationChannel.CloudFogModel.CloudTemp 273.15 K

Example

To set the rain model and rain outage attributes.

First use the Environment_RM GetValue command with the Choices option on the PropagationChannel.RainModel to get the names of valid Rain Models:

Environment_RM * GetValue PropagationChannel.RainModel:Choices

Crane_1985
ITU-R_P618-10
Script_Plugin
CCIR_1983
Crane_1982
ITU-R_P618-5
ITU-R_P618-8
ITU-R_P618-9

Set the rain model and rain outage attributes:

Environment * SetValue PropagationChannel.UseRainModel true
Environment * SetValue PropagationChannel.RainModel ITU-R_P618-5
Environment * SetValue PropagationChannel.RainModel.SurfaceTemperature 78.6 degC
Environment * SetValue RainOutagePercent 0.03

Example

Enable the Urban Model, load a shapefile, and set options:

Environment * SetValue PropagationChannel.UseUrbanTerresPropLossModel true
Environment_RM * GetValue PropagationChannel.UrbanTerresPropLossModel:Choices

Two_Ray
Urban_Propagation_Wireless_InSite_RT

Environment * SetValue PropagationChannel.UrbanTerresPropLossModel Urban_Propagation_Wireless_InSite_RT
Environment_RM * GetValue PropagationChannel.UrbanTerresPropLossModel

PropagationChannel.UrbanTerresPropLossModel.UserComment = Urban Propagation Wireless InSite RT (Wireless InSite real Time Library by Remcom) urban propagation model
PropagationChannel.UrbanTerresPropLossModel.CalculationMethod = TPGEODESIC
PropagationChannel.UrbanTerresPropLossModel.OverrideGeometryTileOrigin = false
PropagationChannel.UrbanTerresPropLossModel.GeometryTileOriginLatitude = 0 rad (Read-only)
PropagationChannel.UrbanTerresPropLossModel.GeometryTileOriginLongitude = 0 rad (Read-only)
PropagationChannel.UrbanTerresPropLossModel.BuildingHeightReferenceMethod = HeightAboveSeaLevel
PropagationChannel.UrbanTerresPropLossModel.BuildingHeightUnit = Meters
PropagationChannel.UrbanTerresPropLossModel.ProjectionHorizontalDarum = Lat/Lon WGS84
PropagationChannel.UrbanTerresPropLossModel.IndoorCalcModel = WALLCOUNT
PropagationChannel.UrbanTerresPropLossModel.BuildingHeightAttribute = NONE
PropagationChannel.UrbanTerresPropLossModel.UrbanGeometryFile = <empty>
PropagationChannel.UrbanTerresPropLossModel.UseTerrainData = false
PropagationChannel.UrbanTerresPropLossModel.TerrainExtentMinLatitude = 0 rad (Read-only)
PropagationChannel.UrbanTerresPropLossModel.TerrainExtentMaxLatitude = 0 rad (Read-only)
PropagationChannel.UrbanTerresPropLossModel.TerrainExtentMinLongitude = 0 rad (Read-only)
PropagationChannel.UrbanTerresPropLossModel.TerrainExtentMaxLongitude = 0 rad (Read-only)
PropagationChannel.UrbanTerresPropLossModel.EnableGroundReflection = false
PropagationChannel.UrbanTerresPropLossModel.SurfaceTemperature = 290.00000000 K

Environment_RM * GetValue PropagationChannel.UrbanTerresPropLossModel.CalculationMethod:Choices

COST_HATA
HATA
OPAR
TPGEODESIC
WALFISCH_IKEGAMI

Environment * SetValue PropagationChannel.UrbanTerresPropLossModel.CalculationMethod HATA
Environment * SetValue PropagationChannel.UrbanTerresPropLossModel.UrbanGeometryFile "C:\temp\myCity.shp"
Environment * SetValue PropagationChannel.UrbanTerresPropLossModel.UseTerrainData true

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Comm

Radar

Scenarios

Version

9.0

STK Programming Interface 11.0.1