Transmitter

Set, add and remove properties for a transmitter.

Syntax

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

Related commands

• Transmitter_RM

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}.

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:

Examples

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:

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:

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:

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

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

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:

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

Examples

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

To see the BeamDirectionProvider list:

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:

Model.Antenna.AntennaControl.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.Antenna.AntennaControl.BeamDirectionProvider.Directions:Size = 1

Set the RF Environment for a transmitter object:

Return message

Group membership

This command belongs to the following group(s):

Comm

Version

10