RFEnvironment
Control the use of environmental models in a scenario
Syntax
RFEnvironment <ScenarioPath | ObjectPath> SetValue <AttributePath> <Value> [<Unit>]
Related commands
Description
The RFEnvironment command enables 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.
You can apply the RFEnvironment command at the scenario level or the object level.
| Parameter | Description |
|---|---|
| <AttributePath> | Specify the path of the attribute being changed. |
| <Value> | The specified attribute will be set to this value. |
| <Unit> | When entering a numeric value, include <Unit> so you can enter the abbreviation of the unit of the numeric value. If you do not include this, then STK assumes the <Value> to be in the internal units. |
Use this command in conjunction with the RFEnvironment_RM GetValue command, which will return a list of attributes or the properties and choices for a specific attribute.
Examples
Set the UseCloudFogModel attribute to true, and specify the ceiling, water density, and temperature:
RFEnvironment * SetValue PropagationChannel.UseCloudFogModel true
RFEnvironment * SetValue PropagationChannel.CloudFogModel.CloudCeiling 8000
RFEnvironment * SetValue PropagationChannel.CloudFogModel.CloudLiqWaterDensity 456.0 kg/km^3
RFEnvironment * SetValue PropagationChannel.CloudFogModel.CloudTemp 273.15 K
Examples
To set the rain model and rain outage attributes
First use the RFEnvironment_RM GetValue command with the Choices option on the PropagationChannel.RainModel to get the names of valid Rain Models:
RFEnvironment_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:
RFEnvironment * SetValue PropagationChannel.UseRainModel true
RFEnvironment * SetValue PropagationChannel.RainModel ITU-R_P618-5
RFEnvironment * SetValue PropagationChannel.RainModel.SurfaceTemperature 78.6 degC
RFEnvironment * SetValue RainOutagePercent 0.03
Examples
Enable the Urban Model, load a shapefile, and set options:
The values permissible for setting PropagationChannel.UrbanTerresPropLossModel.BuildingHeightAttribute depend on the content of the shapefile specified by the PropagationChannel.UrbanTerresPropLossModel.UrbanGeometryFile. When defining these attributes, it is best to set any other attributes first, then set the UrbanGeometryFile attribute and then the BuildingHeightAttribute.
RFEnvironment * SetValue PropagationChannel.UseUrbanTerresPropLossModel true
RFEnvironment_RM * GetValue PropagationChannel.UrbanTerresPropLossModel:Choices
Two_Ray Urban_Propagation_Wireless_InSite_64
RFEnvironment * SetValue PropagationChannel.UrbanTerresPropLossModel Urban_Propagation_Wireless_InSite_64
RFEnvironment_RM * GetValue PropagationChannel.UrbanTerresPropLossModel
PropagationChannel.UrbanTerresPropLossModel.UserComment = Urban Propagation Wireless InSite (Wireless InSite 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 = NONE 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
RFEnvironment_RM * GetValue PropagationChannel.UrbanTerresPropLossModel.CalculationMethod:Choices
COST_HATA HATA TPGEODESIC WALFISCH_IKEGAMI
RFEnvironment * SetValue PropagationChannel.UrbanTerresPropLossModel.CalculationMethod HATA
RFEnvironment * SetValue PropagationChannel.UrbanTerresPropLossModel.UseTerrainData true
RFEnvironment * SetValue PropagationChannel.UrbanTerresPropLossModel.UrbanGeometryFile "C:\temp\myCity.shp"
RFEnvironment * SetValue PropagationChannel.UrbanTerresPropLossModel.BuildingHeightAttribute ZV2
Set the RF Environment for a transmitter object:
Transmitter */Facility/Facility1/Transmitter/Transmitter1/ SetValue RFEnvironment.PropagationChannel.UseRainModel true
Return message
Group membership
This command belongs to the following group(s):
Version
9.0