Get information about an antenna.
Antenna_RM <AntObjectPath> GetValue [<AttributePath>]
The Antenna_RM command allows you to get the value(s) of a specific antenna as pointed to by a specific attribute.
If <AttributePath> is not included then the command will return the list of all attributes, and the values of those attributes, for the antenna.
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.
| 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 Antenna command, which will return a list of attributes, or the properties and choices for a specific attribute.
Return the attributes for an antenna object using the Gaussian model:
Antenna_RM */Satellite/Satellite1/Sensor/Sensor1/Antenna/Antenna1 GetValue
UserComment = STK Antenna Object
Model = Gaussian
Model.UserComment = Analytical model of a Gaussian beam similar to a parabolic antenna within about -6 dB relative to boresight
Model.DesignFrequency = 14500000000.00000000 Hz
Model.InputType = Use Diameter
Model.Diameter = 1.00000000 m
Model.MainlobeGain = 12698.63479991 units (Read-only)
Model.Beamwidth = 0.02787863 rad (Read-only)
Model.BacklobeGain = 0.00100000 units
Model.Efficiency = 0.55000000 unitValue
Orientation = Azimuth Elevation
Orientation.AzimuthAngle = 0 rad
Orientation.ElevationAngle = 1.57079633 rad
Orientation.AboutBoresight = Rotate
Orientation.XPositionOffset = 0 m
Orientation.YPositionOffset = 0 m
Orientation.ZPositionOffset = 0 m
Return the value of the Model.MainlobeGain attribute:
Antenna_RM */Satellite/Satellite1/Sensor/Sensor1/Antenna/Antenna1 GetValue Model.MainlobeGain
Model.MainlobeGain = 12698.63479991 units (Read-only)
Return the properties for the Model.Diameter attribute:
Antenna_RM */Aircraft/Aircraft1/Antenna/LeftAnt GetValue Model.Diameter:Properties
Model.Diameter:Properties.Description = Diameter of antenna (Read-only)
Model.Diameter:Properties.ReadOnly = false
Model.Diameter:Properties.class = QUANTITY
Model.Diameter:Properties.Fixed = true
Model.Diameter:Properties.name = Diameter
Model.Diameter:Properties.Min = 0.00100000 m (Read-only)
Model.Diameter:Properties.Max = 1000.00000000 m (Read-only)
Model.Diameter:Properties.Dimension = SmallDistanceUnit
Model.Diameter:Properties.Unit = m
Return the Orientation choices for an Antenna:
Antenna_RM */Satellite/Satellite1/Sensor/Sensor1/Antenna/Antenna1 GetValue Orientation:Choices
Azimuth Elevation
Euler Angles
Quaternion
YPR Angles
On a Phased Array antenna, enable and add two objects to the BeamDirectionProvider list:
Antenna */Aircraft/Aircraft1/Antenna/Antenna1 SetValue Model.BeamDirectionProvider.Enabled true
Antenna */Aircraft/Aircraft1/Antenna/Antenna1 AddObject Model.BeamDirectionProvider.Directions Facility/Facility1/Radar/Radar2
Antenna */Aircraft/Aircraft1/Antenna/Antenna1 AddObject Model.BeamDirectionProvider.Directions Satellite/Satellite1/Radar/Radar1
To see the BeamDirectionProvider list:
Antenna_RM */Aircraft/Aircraft1/Antenna/Antenna1 GetValue Model.BeamDirectionProvider
Model.BeamDirectionProvider = Object
Model.BeamDirectionProvider.Enabled = true
Model.BeamDirectionProvider.Directions[0] = Facility/Facility1/Radar/Radar2
Model.BeamDirectionProvider.Directions[1] = Satellite/Satellite1/Radar/Radar1
To get the size of the Antenna's BeamDirectionProvider.Directions list:
Antenna_RM */Aircraft/Aircraft1/Antenna/Antenna1 GetValue Model.BeamDirectionProvider.Directions:Size
Model.BeamDirectionProvider.Directions:Size = 2
To remove the first object from the BeamDirectionProvider.Directions list:
Antenna */Aircraft/Aircraft1/Antenna/Antenna1 RemoveObject Model.BeamDirectionProvider.Directions Facility/Facility1/Radar/Radar2
To get the size of the Antenna's BeamDirectionProvider.Directions list:
Antenna_RM */Aircraft/Aircraft1/Antenna/Antenna1 GetValue Model.BeamDirectionProvider.Directions:Size
Model.BeamDirectionProvider.Directions:Size = 1
This command belongs to the following group(s):
9.0
STK Programming Interface 11.0.1