Description | Example | Return Message | Group

Transmitter

Set, add and remove properties for a transmitter.

Syntax

Transmitter <XmObjectPath> {Option} <AttributePath> [<Value>] [<Unit>]

Related Commands

Description

The Transmitter command allows you to define the basic properties of the specified transmitter. This command replaces the Comm Define (Transmitter) command, which has been deprecated.

Valid values for {Option} are SetValue, AddItem, RemoveItem, AddObject, RemoveObject.

The <AttributePath> specifies the attribute to be set, added to or removed from. Use the Transmitter_RM GetValue command to return a list of attributes, or the properties and choices for a specific attribute.

The <Value> parameter is entered if {Option} is SetValue, RemoveItem, AddObject, or RemoveObject.

The following table further describes the {Option}.

{Option}Description
SetValueUse to set the <AttributePath> to the <Value>. Include the <Unit> if specifying a numeric value in a unit other than the internal unit for the attribute.
AddItemUsed 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.

For example, the list of Antenna Beams for a Multibeam Transmitter.

RemoveItemUsed to remove an item from the list pointed to by <AttributePath> and the given index specified in <Value>. The index values begin at 0.
AddObjectUsed 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.
RemoveObjectUsed 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 Transmitter_RM command, which will return a list of attributes, or the properties and choices 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 9STK 10 and forward
Model.Modulator.DataRateModel.DataRate
Model.Modulator.ModulationModel.Modulator
Model.Modulator.Modulation.ExternalModulationFileModel.Modulator.Filename
Model.Modulator.Modulation.FileLoadedModel.Modulator.FileLoaded
Model.Modulator.Modulation.NumberOfPulsesModel.Modulator.NumberOfPulses
Model.Modulator.Modulation.PulsePeriodModel.Modulator.PulsePeriod
Model.Modulator.Modulation.PulseWidthModel.Modulator.PulseWidth
Model.Modulator.Modulation.SubcarrierFrequencyModel.Modulator.SubcarrierFrequency
Model.Modulator.Modulation.UserCommentModel.Modulator.UserComment

Example

To set the Transmitter Model to MultiBeam, and set the MultiBeam attributes of the Transmitter.

First use the Transmitter_RM GetValue command to get the valid model names for the Transmitter:

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

Set the Transmitter Model to Multibeam_Transmitter_Model:

Transmitter */Satellite/Satellite1/Transmitter/XM_S1 SetValue Model Multibeam_Transmitter_Model

The Multibeam model adds one antenna beam to the Transmitter; to add a second antenna beam to the MultiBeam Transmitter use the Transmitter command with the AddItem option:

Transmitter */Satellite/Satellite1/Transmitter/XM_S1 AddItem Model.AntennaSystem.AntennaBeams

Set the Power attribute for the second antenna beam (list items are indexed, and start at 0):

Transmitter */Satellite/Satellite1/Transmitter/XM_S1 SetValue Model.AntennaSystem.AntennaBeams[1].Power 1000.00 W

Use the Transmitter_RM GetValue command to view the values for the second Antenna beam:

Transmitter_RM */Satellite/Satellite1/Transmitter/XM_S1 GetValue Model.AntennaSystem.AntennaBeams[1]

AntennaSystem.AntennaBeams[1].BeamID = Beam002
AntennaSystem.AntennaBeams[1].Active = true
AntennaSystem.AntennaBeams[1].Frequency = 14500000000.00000000 Hz
AntennaSystem.AntennaBeams[1].Power = 1000.00000000 W
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna = Gaussian
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.UserComment = Analytical model of a Gaussian beam similar to a parabolic antenna within about -6 dB relative to boresight
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.DesignFrequency = 14500000000.00000000 Hz (Read-only)
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.InputType = Use Diameter
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.Diameter = 1.00000000 m
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.MainlobeGain = 12698.63479991 units (Read-only)
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.Beamwidth = 0.02787863 rad (Read-only)
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.BacklobeGain = 0.00100000 units
AntennaSystem.AntennaBeams[1].AntennaControl.Antenna.Efficiency = 0.55000000 unitValue
AntennaSystem.AntennaBeams[1].AntennaControl.UsePolarization = false
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation = Azimuth Elevation
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.AzimuthAngle =0 rad
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.ElevationAngle= 1.57079633 rad
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.AboutBoresight= Rotate
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.XPositionOffset = 0 m
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.YPositionOffset = 0 m
AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.ZPositionOffset = 0 m
AntennaSystem.AntennaBeams[1].AntennaType = Gaussian (Read-only)
AntennaSystem.AntennaBeams[1].PolarizationType = None (Read-only)
AntennaSystem.AntennaBeams[1].AzimuthAngle = 0 rad (Read-only)
AntennaSystem.AntennaBeams[1].ElevationAngle = 1.57079633 rad (Read-only)
AntennaSystem.AntennaBeams[1].XPositionOffset = 0 m (Read-only)
AntennaSystem.AntennaBeams[1].YPositionOffset = 0 m (Read-only)
AntennaSystem.AntennaBeams[1].ZPositionOffset = 0 m (Read-only)

To change the orientation attributes of the second Antenna beam:

Transmitter */Satellite/Satellite1/Transmitter/XM_S1 SetValue Model.AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.AzimuthAngle 27.0 deg
Transmitter */Satellite/Satellite1/Transmitter/XM_S1 SetValue Model.AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.ElevationAngle 45.0 deg
Transmitter */Satellite/Satellite1/Transmitter/XM_S1 SetValue Model.AntennaSystem.AntennaBeams[1].AntennaControl.Orientation.AboutBoresight Hold

To remove the second antenna beam, use the Transmitter command with the RemoveItem option:

Transmitter */Satellite/Satellite1/Transmitter/XM_S1 RemoveItem Model.AntennaSystem.AntennaBeams 1

Example

On a Complex Transmitter, whose Antenna is defined as Phased Array, enable and add two objects to the BeamDirectionProvider list:

Transmitter */Aircraft/Aircraft1/Transmitter/XmPA1 SetValue Model.Antenna.AntennaControl.BeamDirectionProvider.Enabled true

Transmitter */Aircraft/Aircraft1/Transmitter/XmPA1 AddObject Model.Antenna.AntennaControl.BeamDirectionProvider.Directions Facility/Facility1/Radar/Radar2

Transmitter */Aircraft/Aircraft1/Transmitter/XmPA1 AddObject Model.Antenna.AntennaControl.BeamDirectionProvider.Directions Satellite/Satellite1/Radar/Radar1

To see the BeamDirectionProvider list:

Transmitter_RM */Aircraft/Aircraft1/Transmitter/XmPA1 GetValue Model.Antenna.AntennaControl.BeamDirectionProvider

Model.Antenna.AntennaControl.BeamDirectionProvider = Object
Model.Antenna.AntennaControl.BeamDirectionProvider.Enabled = true
Model.Antenna.AntennaControl.BeamDirectionProvider.Directions[0] = Facility/Facility1/Radar/Radar2
Model.Antenna.AntennaControl.BeamDirectionProvider.Directions[1] = Satellite/Satellite1/Radar/Radar1

To get the size of the Antenna's BeamDirectionProvider.Directions list:

Transmitter_RM */Aircraft/Aircraft1/Transmitter/XmPA1 GetValue Model.Antenna.AntennaControl.BeamDirectionProvider.Directions:Size

Model.Antenna.AntennaControl.BeamDirectionProvider.Directions:Size = 2

To remove the first object from the BeamDirectionProvider.Directions list:

Transmitter */Aircraft/Aircraft1/Transmitter/XmPA1 RemoveObject Model.Antenna.AntennaControl.BeamDirectionProvider.Directions Facility/Facility1/Radar/Radar2

To get the size of the Antenna's BeamDirectionProvider.Directions list:

Transmitter_RM */Aircraft/Aircraft1/Transmitter/XmPA1 GetValue Model.Antenna.AntennaControl.BeamDirectionProvider.Directions:Size

Model.Antenna.AntennaControl.BeamDirectionProvider.Directions:Size = 1

ReturnMessage

Group Membership

This command belongs to the following group(s):

Comm

Version

10

Open topic with navigation