Antenna
Set, add and remove properties for an antenna.
Syntax
Antenna <AntObjectPath> {Options} <AttributePath> [<Value>] [<Unit>]
Related commands
Description
The Antenna command allows you to define the basic properties of the specified antenna. This command replaces the Comm Antenna command, which has been deprecated.
Valid values for {Options} are SetValue, AddItem, RemoveItem.
The <AttributePath> specifies the attribute to be set, added to or removed from. Use the Antenna_RM GetValue command to return a list of attributes, or the properties and choices for a specific attribute.
The <Value> parameter is entered if {Options} is SetValue or RemoveItem.
The following table further describes the {Options}.
{Options} | Description |
---|---|
SetValue | Use to set the <AttributePath> to the <Value>. Include the <Unit> if specifying a numeric value in a unit other than the currently set unit for the attribute. |
AddItem | Used to add an additional item to a list that is pointed to by <AttributePath>. If the <AttributePath> does not point to a list, this command returns NACK. |
RemoveItem | Used to remove an item from the list pointed to by <AttributePath> and the given index specified in <Value>. The index values begin at 0. |
AddObject | Used to add an object to a list of objects that is pointed to by <AttributePath>. The <Value> is the truncated path of the object to be added. |
RemoveObject | Used to remove an object from the list of objects pointed to by <AttributePath>. The <Value> is the truncated path of the object to be removed. |
Use this command in conjunction with the Antenna_RM command, which will return a list of attributes, or the properties and choices for a specific attribute.
Examples
First use the Antenna_RM GetValue command to get the attributes for the Antenna using a Gaussian model:
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
Set the value of the Orientation AboutBoresight attribute for the Antenna:
Set the value of the Model Efficiency attribute for the Antenna:
Examples
First use the Antenna_RM GetValue command to get the valid model names for the Antenna, below is a partial list of the model names:
Antenna_Script Bessel_Aperture_Circular Bessel_Envelope_Aperture_Circular Cosecant_Squared Cosine_Aperture_Circular Cosine_Aperture_Rectangular ... ITU-R_S1528_1.3 ITU-R_S465-5 ITU-R_S580-5 ITU-R_S672-4_Circular ITU-R_S672-4_Rectangular ITU-R_S731 Intelsat_Antenna_Pattern Isotropic Parabolic Pencil_Beam ... Sinc_Integer_Power_Aperture_Rectangular Sinc_Real_Power_Aperture_Circular Sinc_Real_Power_Aperture_Rectangular Square_Horn Uniform_Aperture_Circular Uniform_Aperture_Rectangular
Set the Model for the Antenna to Parabolic:
Get the Orientation choices for the Antenna:
Azimuth Elevation Euler Angles Quaternion YPR Angles
Set the Antenna orientation and orientation attributes:
Examples
On a Phased Array antenna, enable and add two objects to the BeamDirectionProvider list:
To see the BeamDirectionProvider list:
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:
Model.BeamDirectionProvider.Directions:Size = 2
To remove the first object from the BeamDirectionProvider.Directions list:
To get the size of the Antenna's BeamDirectionProvider.Directions list:
Model.BeamDirectionProvider.Directions:Size = 1
Return message
Group membership
This command belongs to the following group(s):
Version
9.0