Get information about a transmitter's properties.
Transmitter_RM <ObjectPath> GetValue [<AttributePath>]
The Transmitter_RM command allows you to get the value(s) of a specific transmitter 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 transmitter.
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 Transmitter command which is used to set properties for a specific attribute.
In STK10 some Transmitter attribute names have been changed. The following table shows the attribute names in STK 9 and the updated names that should be used going forward:
| STK 9 | STK 10 and forward |
|---|---|
| Model.Modulator.DataRate | Model.DataRate |
| Model.Modulator.Modulation | Model.Modulator |
| Model.Modulator.Modulation.ExternalModulationFile | Model.Modulator.Filename |
| Model.Modulator.Modulation.FileLoaded | Model.Modulator.FileLoaded |
| Model.Modulator.Modulation.NumberOfPulses | Model.Modulator.NumberOfPulses |
| Model.Modulator.Modulation.PulsePeriod | Model.Modulator.PulsePeriod |
| Model.Modulator.Modulation.PulseWidth | Model.Modulator.PulseWidth |
| Model.Modulator.Modulation.SubcarrierFrequency | Model.Modulator.SubcarrierFrequency |
| Model.Modulator.Modulation.UserComment | Model.Modulator.UserComment |
Return all the attributes for the Transmitter:
Transmitter_RM */Facility/Facility1/Transmitter/Transmitter1 GetValue
UserComment = STK Transmitter Object
Model = Simple_Transmitter_Model
Model.UserComment = Simple model of a transmitter
Model.UseFilter = false
Model.PostTransmitGainsLosses.GainLossList (Empty List)
Model.PostTransmitGainsLosses.TotalGain = 1.00000000 units (Read-only)
Model.Frequency = 14500000000.00000000 Hz
Model.Modulator = BPSK
Model.Modulator.UserComment = BPSK
Model.Modulator.UseSignalPSD = false
Model.Modulator.NumPSDNulls = 15 (Read-only)
Model.Modulator.UseCDMASpread = false
Model.Modulator.AutoScaleBandwidth = true
Model.Modulator.UpperBandwidthLimit = 16000000.00000000 Hz (Read-only)
Model.Modulator.LowerBandwidthLimit = -16000000.00000000 Hz (Read-only)
Model.Modulator.Bandwidth = 32000000.00000000 Hz (Read-only)
Model.DataRate = 16000000.00000000 b*sec^-1
Model.EIRP = 1000.00000000 W
Model.UsePolarization = false
Model.Gain = 1.00000000 units (Read-only)
Model.Power = 1000.00000000 W (Read-only)
Return the choices for the Model attribute:
Transmitter_RM */Satellite/Satellite1/Transmitter/XM_S1 GetValue Model:Choices
Complex_Re-Transmitter_Model
Complex_Transmitter_Model
GPS_Satellite_Transmitter_Model
Laser_Transmitter_Model
Medium_Re-Transmitter_Model
Medium_Transmitter_Model
Multibeam_Transmitter_Model
Script_Plugin_Laser_Transmitter_Model
Script_Plugin_RF_Transmitter_Model
Simple_Re-Transmitter_Model
Simple_Transmitter_Model
Return the properties for the EIRP attribute:
Transmitter_RM */Facility/Facility1/Transmitter/Transmitter1 GetValue Model.EIRP:Properties
Model.EIRP:Properties.Description = The transmitter's effective isotropic power. (Read-only)
Model.EIRP:Properties.ReadOnly = false
Model.EIRP:Properties.class = QUANTITY
Model.EIRP:Properties.Fixed = true
Model.EIRP:Properties.name = EIRP
Model.EIRP:Properties.Min = 1e-289 W (Read-only)
Model.EIRP:Properties.Max = 1e+289 W (Read-only)
Model.EIRP:Properties.Dimension = PowerUnit
Model.EIRP:Properties.Unit = W
Return the size of the Transmitter's gain/loss list, add an item to the list and then check the size and values:
Transmitter_RM */Facility/Facility1/Transmitter/Transmitter1 GetValue Model.PostTransmitGainsLosses.GainLossList:Size
Model.PostTransmitGainsLosses.GainLossList:Size = 0
To add an item to the GainLossList:
Transmitter */Facility/Facility1/Transmitter/Transmitter1 AddItem Model.PostTransmitGainsLosses.GainLossList
Transmitter */Facility/Facility1/Transmitter/Transmitter1 SetValue Model.PostTransmitGainsLosses.GainLossList[0].Identifier AAA
Transmitter */Facility/Facility1/Transmitter/Transmitter1 SetValue Model.PostTransmitGainsLosses.GainLossList[0].Gain 10.04
To get the number of items in the GainLossList:
Transmitter_RM */Facility/Facility1/Transmitter/Transmitter1 GetValue Model.PostTransmitGainsLosses.GainLossList:Size
Model.PostTransmitGainsLosses.GainLossList:Size = 1
To get the value of the items in the GainLossList:
Transmitter_RM */Facility/Facility1/Transmitter/Transmitter1 GetValue Model.PostTransmitGainsLosses.GainLossList
Model.PostTransmitGainsLosses.GainLossList[0].Identifier = AAA
Model.PostTransmitGainsLosses.GainLossList[0].Gain = 10.040000000 units
To remove the item from the GainLossList:
Transmitter */Facility/Facility1/Transmitter/Transmitter1 RemoveItem Model.PostTransmitGainsLosses.GainLossList 0
This command belongs to the following group(s):
10
STK Programming Interface 11.0.1