Atmosphere_RM
Get information about atmospheric models.
Syntax
Atmosphere_RM <ObjectPath> GetValue [<AttributePath>]
Related commands
This command is DEPRECATED and has been replaced by:
RFEnvironment_RMDescription
The Atmosphere_RM command allows you to get the value(s) of specific atmospheric absorption models as pointed to by a specific attribute.
Valid objects for <ObjectPath> are Facilities, Places, Targets, Ground Vehicles, Ships, Aircraft, LaunchVehicles and Missiles.
If <AttributePath> is not included then the command will return the list of all attributes, and the values of those attributes.
Use the Atmosphere command to set attribute values.
There are three properties common to all attributes that can be used to retrieve information about them - Properties, Choices, and Size. These properties should be placed at the end of the attribute path, separated from the attribute by a colon (e.g., :Choices). The following table describes these properties.
The command with Properties, Choices or Size specified may nack if the property is not valid the for attribute.
| Property | Description |
|---|---|
| Properties | Use Properties to retrieve the currently defined values of all of the properties of the attribute. This includes items such as minimum and maximum values of the attribute, the dimension and unit of the attribute, etc. |
| Choices | The Choices property returns a list of all possible choices for non-Boolean attributes with specific arrays of values. |
| Size | The Size property returns the number of rows in the attribute's list, for attributes that can have rows of values. |
Use this command in conjunction with the Atmosphere command which is used to set properties for a specific attribute.
Examples
Return the name and value of the Atmosphere attributes for Facility1:
Return message
UserComment = STK Atmosphere Extension InheritAtmosAbsorptionModel = true AtmosAbsorptionModel = Simple_Satcom (Read-only) AtmosAbsorptionModel.UserComment = Simple Satcom gaseous absorption model (Read-only) AtmosAbsorptionModel.SurfaceTemperature = 293.15000000 K (Read-only) AtmosAbsorptionModel.WaterVaporConcentration = 7.50000000 g*m^-3 (Read-only) EnableLocalRainData = false LocalRainIsoHeight = 2000.00000000 m (Read-only) LocalRainRate = 1.00000000 mm*hr^-1 (Read-only) LocalSurfaceTemp = 293.15000000 K (Read-only)
Examples
Return the Properties of the AtmosAbsorptionModel.SurfaceTemperature attribute:
Return message
AtmosAbsorptionModel.SurfaceTemperature:Properties.Description = Surface Temperature (Read-only) AtmosAbsorptionModel.SurfaceTemperature:Properties.ReadOnly = true AtmosAbsorptionModel.SurfaceTemperature:Properties.class = QUANTITY AtmosAbsorptionModel.SurfaceTemperature:Properties.Fixed = true AtmosAbsorptionModel.SurfaceTemperature:Properties.name = SurfaceTemperature AtmosAbsorptionModel.SurfaceTemperature:Properties.Min = 173.15000000 K (Read-only) AtmosAbsorptionModel.SurfaceTemperature:Properties.Max = 373.15000000 K (Read-only) AtmosAbsorptionModel.SurfaceTemperature:Properties.Dimension = Temperature AtmosAbsorptionModel.SurfaceTemperature:Properties.Unit = K
Examples
Return the value of the LocalRainIsoHeight attribute:
Return message
LocalRainIsoHeight = 2000.00000000 m (Read-only)
Examples
To see the available Atmospheric Absorption Model names use the Atmosphere_RM GetValue command with the Choices option on the AtmosAbsorptionModel attribute:
ITU-R_P676-5 Script_Plugin Simple_Satcom TIREM_3.31 ITU-R_P676-3 TIREM_3.20
To change the Atmospheric Absorption Model to ITU-R_P676-5:
Now use the Atmosphere_RM GetValue command, specifying the AtmosAbsorptionModel attribute to get the current settings of the Facility's atmosphere attributes.
AtmosAbsorptionModel = ITU-R_P676-5 AtmosAbsorptionModel.UserComment = ITU-R P676-5 gaseous absorption model AtmosAbsorptionModel.UseApproxMethod = true AtmosAbsorptionModel.UseSeasonalRegional = true
Group membership
This command belongs to the following group(s):
Version
9.0