Get information about a receiver.
Receiver_RM <RcObjectPath> GetValue [<AttributePath>]
The Receiver_RM command allows you to get the value(s) of a specific receiver 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 receiver.
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 Receiver command which is used to set properties for a specific attribute.
Return all the attributes for the Receiver:
Receiver_RM */Facility/Facility1/Receiver/Receiver1 GetValue
UserComment = STK Receiver Object
Model = Simple_Receiver_Model
Model.UserComment = Simple model of a receiver
Model.AutoSelectDemodulator = true
Model.UseFilter = false
Model.AutoScaleBandwidth = true
Model.PreReceiveGainsLosses.GainLossList (Empty List)
Model.PreReceiveGainsLosses.TotalGain = 1.00000000 units (Read-only)
Model.PreDemodGainsLosses.GainLossList (Empty List)
Model.PreDemodGainsLosses.TotalGain = 1.00000000 units (Read-only)
Model.EnableLinkMargin = false
Model.GOverT = 100.00000000 units*K^-1
Model.UsePolarization = false
Model.FrequencyAutoTracking = true
Model.AntennaGain = 1.00000000 units (Read-only)
After adding three items to the Receiver's PreReceiveGainsLosses list, return the properties of the list:
Receiver_RM */Facility/Facility1/Receiver/Receiver1 GetValue Model.PreReceiveGainsLosses.GainLossList:Properties
Model.PreReceiveGainsLosses.GainLossList:Properties.Description = GainLossList (Read-only)
Model.PreReceiveGainsLosses.GainLossList:Properties.ReadOnly = false
Model.PreReceiveGainsLosses.GainLossList:Properties.class = LIST
Model.PreReceiveGainsLosses.GainLossList:Properties.Fixed = true
Model.PreReceiveGainsLosses.GainLossList:Properties.name = GainLossList
Model.PreReceiveGainsLosses.GainLossList:Properties.size = 3
Return the size of the Receiver PreReceiveGainsLosses list:
Receiver_RM */Facility/Facility1/Receiver/Receiver1 GetValue Model.PreReceiveGainsLosses.GainLossList:Size
Model.PreReceiveGainsLosses.GainLossList:Size = 3
Return the value of the Gain attribute for the first item in the GainLossList:
Receiver_RM */Facility/Facility1/Receiver/Receiver1 GetValue Model.PreReceiveGainsLosses.GainLossList[0].Gain
Model.PreReceiveGainsLosses.GainLossList[0].Gain = 1.00000000 units
Add another item to the GainLossList, and set it's attributes, then check the values you've just set:
Receiver */Facility/Facility1/Receiver/Receiver1 AddItem Model.PreReceiveGainsLosses.GainLossList
Receiver */Facility/Facility1/Receiver/Receiver1 SetValue Model.PreReceiveGainsLosses.GainLossList[3].Identifier AAA
Receiver */Facility/Facility1/Receiver/Receiver1 SetValue Model.PreReceiveGainsLosses.GainLossList[3].Gain 10.04
Receiver_RM */Facility/Facility1/Receiver/Receiver1 GetValue Model.PreReceiveGainsLosses.GainLossList[3]
Model.PreReceiveGainsLosses.GainLossList[3].Identifier = AAA
Model.PreReceiveGainsLosses.GainLossList[3].Gain = 10.040000000 units
Return the choices for the Receiver Model type:
Receiver_RM */Facility/Facility1/Receiver/Receiver1 GetValue Model:Choices
Cable_Receiver_Model
Complex_Receiver_Model
Laser_Receiver_Model
Medium_Receiver_Model
Multibeam_Receiver_Model
Script_Plugin_Laser_Receiver_Model
Script_Plugin_RF_Receiver_Model
Simple_Receiver_Model
This command belongs to the following group(s):
9.0
STK Programming Interface 11.0.1