Description | Example | Return Message | Group

Radar_RM

Get information about a radar's properties.

Syntax

Radar_RM <ObjectPath> GetValue [<AttributePath>]

Related Commands

Description

The Radar_RM command allows you to get the value(s) of a specific radar as pointed to by a specific attribute.

If <AttributePath> is not included then the command will return the list of attributes, and the values of those attributes, for the radar.

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.

Note: 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 Radar command which is used to set properties for a specific attribute.

Example

Return all the attributes for the Radar:

Radar_RM */Facility/Facility1/Radar/Radar1 GetValue

Return all the attributes for the Radar Antenna control:

Radar_RM */Facility/Facility1/Radar/Radar1 GetValue Model.AntennaControl

Model.AntennaControl.AntennaReferenceType = Embed (Read-only)
Model.AntennaControl.Antenna = Parabolic
Model.AntennaControl.Antenna.UserComment = Analytical model of a uniformly illuminated parabolic antenna
Model.AntennaControl.Antenna.DesignFrequency = 2997924580.00000000 Hz (Read-only)
Model.AntennaControl.Antenna.InputType = Use Diameter
Model.AntennaControl.Antenna.Diameter = 1.00000000 m
Model.AntennaControl.Antenna.MainlobeGain = 542.82824206 units (Read-only)
Model.AntennaControl.Antenna.Beamwidth = 0.10294485 rad (Read-only)
Model.AntennaControl.Antenna.BacklobeGain = 0.00100000 units
Model.AntennaControl.Antenna.UseAsMainlobeAttenuation = false
Model.AntennaControl.Antenna.Efficiency = 0.55000000 unitValue
Model.AntennaControl.Orientation = Azimuth Elevation
Model.AntennaControl.Orientation.AzimuthAngle = 0 rad
Model.AntennaControl.Orientation.ElevationAngle = 1.57079633 rad
Model.AntennaControl.Orientation.AboutBoresight = Rotate
Model.AntennaControl.Orientation.XPositionOffset = 0 m
Model.AntennaControl.Orientation.YPositionOffset = 0 m
Model.AntennaControl.Orientation.ZPositionOffset = 0 m

Example

Return the choices for the Antenna attribute:

Radar_RM */Facility/Facility1/Radar/Radar1 GetValue Model.AntennaControl.Antenna:Choices

Antenna_Script
Bessel_Aperture_Circular
Bessel_Envelope_Aperture_Circular
Cosecant_Squared
Cosine_Aperture_Circular
Cosine_Aperture_Rectangular
Cosine_Pedestal_Aperture_Circular
Cosine_Pedestal_Aperture_Rectangular
Cosine_Squared_Aperture_Circular
Cosine_Squared_Pedestal_Aperture_Circular
Cosine_Squared_Pedestal_Aperture_Rectangular
Dipole
External_Antenna_Pattern
...
Square_Horn
Uniform_Aperture_Circular
Uniform_Aperture_Rectangular

Example

Return the properties for the AzimuthAngle attribute:

Radar_RM */Facility/Facility1/Radar/Radar1 GetValue Model.AntennaControl.Orientation.AzimuthAngle:Properties

Model.AntennaControl.Orientation.AzimuthAngle:Properties.Description = AzimuthAngle (Read-only)
Model.AntennaControl.Orientation.AzimuthAngle:Properties.ReadOnly = false
Model.AntennaControl.Orientation.AzimuthAngle:Properties.class = QUANTITY
Model.AntennaControl.Orientation.AzimuthAngle:Properties.Fixed = true
Model.AntennaControl.Orientation.AzimuthAngle:Properties.name = AzimuthAngle
Model.AntennaControl.Orientation.AzimuthAngle:Properties.Min = -3.14159265 rad (Read-only)
Model.AntennaControl.Orientation.AzimuthAngle:Properties.Max = 6.28318531 rad (Read-only)
Model.AntennaControl.Orientation.AzimuthAngle:Properties.Dimension = AngleUnit
Model.AntennaControl.Orientation.AzimuthAngle:Properties.Unit = rad

Example

Add two items to the GainLoss list:

Radar */Satellite/Satellite1/Radar/Radar1 AddItem Model.Receiver.AdditionalGainsLosses.GainLossList

Radar */Satellite/Satellite1/Radar/Radar1 AddItem Model.Receiver.AdditionalGainsLosses.GainLossList

Return the size of the GainLoss list:

Radar_RM */Satellite/Satellite1/Radar/Radar1 GetValue Model.PreReceiveGainsLosses.GainLossList:Size

Model.PreReceiveGainsLosses.GainLossList:Size = 2

To set the gain/loss parameters:

Radar */Satellite/Satellite1/Radar/Radar1 SetValue Model.Receiver.AdditionalGainsLosses.GainLossList[0].Identifier Abc

Radar */Satellite/Satellite1/Radar/Radar1 SetValue Model.Receiver.AdditionalGainsLosses.GainLossList[0].Gain 10.05

To see the gain/loss parameters:

Radar_RM */Satellite/Satellite1/Radar/Radar1 GetValue Model.Receiver.AdditionalGainsLosses.GainLossList

Model.Receiver.AdditionalGainsLosses.GainLossList[0].Identifier = Abc
Model.Receiver.AdditionalGainsLosses.GainLossList[0].Gain = 10.05000000 units
Model.Receiver.AdditionalGainsLosses.GainLossList[1].Identifier = Misc.
Model.Receiver.AdditionalGainsLosses.GainLossList[1].Gain = 1.00000000 units

To remove the first item (index 0) from the gain/loss list:

Radar */Satellite/Satellite1/Radar/Radar1 RemoveItem Model.Receiver.AdditionalGainsLosses.GainLossList 0

Group Membership

This command belongs to the following group(s):

Radar

Version

10.1

STK Programming Interface 11.0.1