There are a number of commands for the STK Communications module
that can be executed through Connect. These commands allow you to
control the definition and graphical display of Receiver,
Transmitter, Antenna and CommSystem
objects. For most commands associated with the Communications
module, the actual command name is Comm. The generic
structure of most Communications commands is:
Comm <ObjectPath> {CommOption} <Parameters>
The {CommOption} indicates the action being
executed by the command, and will change depending on the action
you wish to take. Additional <Parameters> may be
required depending on the {CommOption} specified.
| Command | Format | Description | Version |
|---|---|---|---|
| Antenna | Antenna <AntObjectPath> {Options} <AttributePath> [<Value>] [<Unit>] | Set, add and remove properties for an antenna. | 9.0 |
| Antenna_RM | Antenna_RM <AntObjectPath> GetValue [<AttributePath>] | Get information about an antenna. | 9.0 |
| Atmosphere | Atmosphere <ObjectPath> SetValue <AttributePath> <Value> [<Unit>] | Control the use of atmospheric models | 9.0 |
| Atmosphere (Comm & Radar) | Atmosphere <ObjectPath> {AtmosphericModel} | Control the use of atmospheric models (Deprecated Command) | 9.0 |
| Atmosphere_RM | Atmosphere_RM <ObjectPath> GetValue [<AttributePath>] | Get information about atmospheric models. | 9.0 |
| CalculationTool | CalculationTool <ScenarioPath> {Options} | Define coordinate systems and elements used in constructing them, including templates. | 10.1.1 |
| CalculationTool Condition | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Condition" | "ConditionTemplate"} <ComponentName> [{ConditionType} <TypeParams>] | Define and modify Condition components and templates. | 10 |
| CalculationTool Condition Set | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Condition Set" | "Condition SetTemplate"} <ComponentName> [{ConditionType} <TypeParams>] | Define and modify Condition Set components and templates. | 10.1 |
| CalculationTool Parameter Set | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Parameter Set" | "Parameter SetTemplate"} <ComponentName> [{ParameterSetType} <TypeParams>] | Define and modify Parameter Set components and templates. | 10 |
| CalculationTool Scalar Calculation | CalculationTool <ScenarioPath> <ParentObject> {Action} {"Scalar Calculation" | "Scalar CalculationTemplate"} <ComponentName> [{ScalarCalculationType} <TypeParams>] | Define and modify Scalar Calculation components and templates. | 11 |
| CalculationTool_R | CalculationTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about CalculationTool components. | 11 |
| CalculationTool_RM | CalculationTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about CalculationTool components. | 10.1 |
| CentralBody_R | CentralBody_R <ApplicationPath> <ObjectPath> | Returns the name of the central body of any object | 10.0.2 |
| Comm Antenna | Comm <CommObjectPath> Antenna [MultiBeam <BeamID>] {AntennaType} <Parameters> | Set the antenna properties of a receiver or transmitter (Deprecated Command) | 9.0 |
| Comm CommSystem AccessOptions | Comm <CommSysObjectPath> CommSystem AccessOptions <Parameters> | Set or modify access options for a CommSystem (Deprecated Command) | 11 |
| Comm CommSystem Clear | Comm <CommSysObjectPath> CommSystem Clear | Clear the graphics and any cached compute data. (Deprecated Command) | 11 |
| Comm CommSystem Compute | Comm <CommSysObjectPath> CommSystem Compute [NOW] | Calculates link and interference data for a Comm System (Deprecated Command) | 11 |
| Comm CommSystem IFSources | Comm <CommSysObjectPath> CommSystem IFSources {Action} <TruncObjectPath> | Add or remove a constellation from the list of interfering constellations for a comm system (Deprecated Command) | 11 |
| Comm CommSystem Interference | Comm <CommSysObjectPath> CommSystem Interference {Yes | No} [{PFDRefBandwidth}] | Control the calculation of interference (Deprecated Command) | 11 |
| Comm CommSystem Interval | Comm <CommSysObjectPath> CommSystem Interval {UseScenarioTime} <StepSize> [{TimeInterval}] | Set the time interval to be used for computing a comm system (Deprecated Command) | 11 |
| Comm CommSystem LinkDefinition | Comm <CommSysObjectPath> CommSystem LinkDefinition {Receive | Transmit} {LinkCriteria} | Define the constraining constellation and link criteria for a comm system (Deprecated Command) | 11 |
| Comm CommSystem Receive | Comm <CommSysObjectPath> CommSystem Receive {Action} <TruncObjectPath> | Add or remove a constellation(s) to carry out the receive function for the comm system (Deprecated Command) | 11 |
| Comm CommSystem SaveLevel | Comm <CommSysObjectPath> CommSystem SaveLevel {SaveOptions} | Control how a Comm System is saved (Deprecated Command) | 9.0 |
| Comm CommSystem SaveMode | Comm <CommSysObjectPath> CommSystem SaveMode {Option} | Specify save and load behavior for a CommSystem (Deprecated Command) | 11 |
| Comm CommSystem Transmit | Comm <CommSysObjectPath> CommSystem Transmit {Action} <TruncObjectPath> | Add or remove a constellation to carry out the transmit function in the communication link analysis (Deprecated Command) | 11 |
| Comm Define (Receiver) | Comm <RcObjectPath> Define RcvrModel {ModelType} <Parameters> | Set basic properties of a receiver (Deprecated Command) | 9.0 |
| Comm Define (Transmitter) | Comm <XmObjectPath> Define XmtrModel {XmType} {ModelType} <Parameters> | Set the basic properties of a transmitter (Deprecated Command) | 9.0 |
| Comm Filter | Comm <CommObjectPath> Filter {On | Off | Define} [{FilterType} <UpperBandLimit> <LowerBandLimit> <InsertionLoss> {AdditionalParams}] | Define power spectrum filters for transmitters and receivers (Deprecated Command) | 9.0 |
| Comm GainLoss | Comm <ObjectPath> GainLoss [{PreReceive | PreDemod}] {ListOptions} | Create a list of pre-receive or pre-demodulation gains and losses for a receiver or post-transmit gains and losses for a transmitter that will be added to the link equation (Deprecated Command) | 9.0 |
| Comm Modulation (Transmitter) | Comm <XmObjectPath> Modulation {ModulationOptions} | Set the modulation details for a transmitter (Deprecated Command) | 9.0 |
| Comm Orient | Comm <CommObjectPath> Orient [MultiBeam <BeamID>] {Orientation} <Parameters> | Set the antenna orientation of a receiver or transmitter (Deprecated Command) | 9.0 |
| Comm Polarize | Comm <ObjectPath> Polarize [MultiBeam <BeamID>] {PolarizationParams} | Set the polarization values for a receiver or transmitter (Deprecated Command) | 9.0 |
| Comm RainModel (Receiver) | Comm <CommObjectPath> RainModel {State} [<Outage>] | Set outage values for rain models (Deprecated Command) | 9.0 |
| Comm SysTemp (Receiver) | Comm <ObjectPath> SysTemp {SystemOption} <Parameters> | Set RF system temperature properties for receivers (Deprecated Command) | 9.0 |
| Comm TransferFunc (Transmitter) | Comm <XmObjectPath> TransferFunc {CoeffType} <Value1> [<Value2>...] | Add transfer function coefficient values to a transmitter (Deprecated Command) | 9.0 |
| CommQuery | CommQuery <CommObjectPath> [{QueryType}] | Return information about a transmitter or receiver (Deprecated Command) | 9.0 |
| CommSystem | CommSystem <CommSystemPath> {Options} [<Parameters>] | Set or modify options for a CommSystem | 11 |
| CommSystem_RM | CommSystem_RM <CommSystemPath> GetValue [<AttributePath>] | Get information about a CommSystem. | 11 |
| Copy | Copy <ApplicationPath> <CopyFromObjectPath> [{CopyOption}] | Copy and paste an object. | 8.0 |
| Environment | Environment <ScenarioPath> SetValue <AttributePath> <Value> [<Unit>] | Control the use of environmental models in a scenario | 9.0 |
| Environment (Comm & Radar) | Environment <ScenarioPath> {EnvironmentOption} | Control the use of environmental models in a scenario (Deprecated Command) | 9.0 |
| Environment_RM | Environment_RM <ScenarioPath> GetValue [<AttributePath>] | Get information about environmental models. | 9.0 |
| ExternalData | ExternalData <ObjectPath> {DataOption} [<Parameters>] | Allow for the association and management of time ordered data computed outside of STK with STK objects. | 10 |
| GetDescription | GetDescription <ObjectPath> {Type} | Return the description of an object | 4.0.6 |
| Graphics (Comm) | Graphics <CommObjectPath> {GfxType} <Parameters> | Set the graphics properties of a receiver, transmitter or antenna | 4.1.1 |
| Graphics Boresight (Comm) | Graphics <ObjectPath> Boresight {On | Off} [{Color} {MarkerType}] | Control the display of boresight graphics in the 2D Graphics window | 4.1.1 |
| Graphics ContourSet | Graphics <CommObjectPath> ContourSet {ContourOption} <Parameters> | Control the antenna pattern resolution for contouring. | 6.0 |
| Graphics Contours (Comm & Radar) | Graphics <ObjectPath> Contours {ContourType} {ShowGfxState} {RelMaxState} | Set generic contour options for a receiver, transmitter, radar or antenna | 7.1 |
| Graphics Levels (Comm & Radar) | Graphics <CommObjectPath> Levels {AddMethod} <Parameters> | Set and modify the display of contour levels for a receiver, transmitter, radar or antenna | 7.1 |
| Graphics Marker | Graphics <ObjectPath> Marker {MarkerType} ["<FilePath>" [{CustomOptions}]] | Define a marker to represent an object in a 2D Graphics window | 6.0 |
| Graphics ObjectStateInWin | Graphics <ScenarioPath> ObjectStateInWin {Options} | Control the display of objects' graphics in the 2D window. | 7.0 |
| Graphics Pattern (Comm & Radar) | Graphics <CommObjectPath> Pattern <NumberOfPhiPoints> <MinPhi> <MaxPhi> <NumberOfThetaPoints> <MinTheta> <MaxTheta> | Control the antenna grid size and resolution for contour graphics | 4.1.1 |
| Graphics Show | Graphics <ObjectPath> Show {On | Off} | To turn on or off the graphics display of an object. | 10 |
| Graphics WindowState | Graphics <ObjectPath> WindowState {Options} | Control the display of object graphics in the 2D window. | 10 |
| Load | Load <ApplicationPath> {<ClassPath> | VDF} "<FilePath>" | Open an existing scenario or insert an object into the current scenario | 8.0 |
| New | New <ApplicationPath> <ClassPath> <NewObjectName> {NewOptions} | Create a new scenario or add a new object to the current scenario | 8.1 |
| NewMulti | NewMulti <ApplicationPath> <ClassPathOfObjectToCreate> <NumToCreate> <NewName1> [<NewName2>...] [NoDefault] [Ignore] | Create multiple instances of new objects | 4.2 |
| Receiver | Receiver <RcObjectPath> {Options} <AttributePath> [<Value>] [<Unit>] | Set, add and remove properties for a receiver. | 9.0 |
| Receiver_RM | Receiver_RM <RcObjectPath> GetValue [<AttributePath>] | Get information about a receiver. | 9.0 |
| Refraction | Refraction <ObjectPath> {Options} | Set refraction properties for sensor, radar, receiver, transmitter or antenna. | 8.0 |
| Rename | Rename <ObjectPath> <NewName> | Rename an object | 4.0 |
| Save | Save <ApplicationPath> <ObjectPath> ["<SaveInDirectory>"] | Save a scenario or object within a scenario | 4.0 |
| SaveAs | SaveAs <ApplicationPath> <ObjectPath> "<FilePath>" | Save a scenario or object within a scenario with a different name | 4.2 |
| SetAsDefault | SetAsDefault <ApplicationPath> [<ObjectPath>] | Save the indicated object as the default | 4.2 |
| SetConstraint (Comm) | SetConstraint <ObjectPath> {ConstraintName} <Parameters> | Set a constraint for a receiver, transmitter or antenna | 10.1 |
| SetConstraintOptions | SetConstraintOptions <ObjectPath> {ConstraintName} {Options} | Set constraint options for an object's active constraints. | 9.2.2 |
| SetDescription | SetDescription <ObjectPath> {Type} [{Option}] "<Description>" | Set the long or short description of a scenario or object | 6.2 |
| SpatialTool | SpatialTool <ScenarioPath> {Options} | Define volumes and elements used in constructing them, including templates. | 11 |
| SpatialTool Spatial Calculation | SpatialTool <ScenarioPath> <ParentObject> {Action} {Spatial Calculation | Spatial CalculationTemplate} <Spatial CalculationName> [{Spatial CalculationType} <Spatial CalculationTypeParams>] | Define and modify Spatial Calculation components and templates. | 11 |
| SpatialTool Spatial Condition | SpatialTool <ScenarioPath> <ParentObject> {Action} {Spatial Condition | Spatial ConditionTemplate} <Spatial ConditionName> [{Spatial ConditionType} <Spatial ConditionTypeParams>] | Define and modify Spatial Condition components and templates. | 11 |
| SpatialTool Volume Grid | SpatialTool <ScenarioPath> <ParentObject> {Action} {Volume Grid | Volume GridTemplate} <Volume GridName> [{Volume GridType} <Volume GridTypeParams>] | Define and modify Volume Grid components and templates. | 11 |
| SpatialTool_R | SpatialTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about Spatial components. | 11 |
| SpatialTool_RM | SpatialTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about SpatialTool components. | 11 |
| TimeTool | TimeTool <ScenarioPath> {Options} | Define components defining instances or intervals of time. | 10.1.1 |
| TimeTool Collection of Interval Lists | TimeTool <ScenarioPath> <ParentObject> {Action} {"Collection of Interval Lists" | "Collection of Interval ListsTemplate"} <ComponentName> [{CollectionOfIntervalListsType} <TypeParams>] | Define and modify Collection of Interval Lists components and templates. | 10.1 |
| TimeTool Interval | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval" | "IntervalTemplate"} <ComponentName> [{IntervalType} <TypeParams>] | Define and modify Interval components and templates. | 10 |
| TimeTool Interval List | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval List" | "Interval ListTemplate"} <ComponentName> [{IntervalListType} <TypeParams>] | Define and modify Interval List components and templates. | 10.0.1 |
| TimeTool Time Array | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Array" | "Time ArrayTemplate"} <ComponentName> [{TimeArrayType} <TypeParams>] | Define and modify Time Array components and templates. | 10.1 |
| TimeTool Time Instant | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Instant" | "Time InstantTemplate"} <ComponentName> [{TimeInstantType} <TypeParams>] | Define and modify Time Instant components and templates. | 10 |
| TimeTool_R | TimeTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10 |
| TimeTool_RM | TimeTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10.1 |
| Transmitter | Transmitter <XmObjectPath> {Option} <AttributePath> [<Value>] [<Unit>] | Set, add and remove properties for a transmitter. | 10 |
| Transmitter_RM | Transmitter_RM <ObjectPath> GetValue [<AttributePath>] | Get information about a transmitter's properties. | 10 |
| Unload | Unload <ApplicationPath> <ObjectPath> [RemAssignedObjs] | Remove an object or scenario | 4.0 |
| UnloadMulti | UnloadMulti <ApplicationPath> <ObjectPath> | Remove an object and all of its subobjects from the current scenario | 9.1 |
| VO Contours | VO <ObjectPath> Contours {On | Off} | Display contour levels in a 3D window for Comm and Radar objects. | 5.0.4 |
| VO ObjectStateInWin | VO <ScenarioPath> ObjectStateInWin {Options} | Control the display of object graphics in the 3D window. | 7.0 |
| VO Volumes | VO <ObjectPath> Volumes {VolumeOption} [<Parameter>] | Display antenna patterns in the 3D Graphics window | 11 |
| VO WindowState | VO <ObjectPath> WindowState {Options} | Control the display of object graphics in the 3D window. | 10 |
| VectorTool | VectorTool <ScenarioPath> {Options} | Define coordinate systems and elements used in constructing them, including templates. | 10.1.1 |
| VectorTool Angle | VectorTool <ScenarioPath> <ParentObject> {Action} {Angle | AngleTemplate} <AngleName> [{AngleType} <AngleTypeParams>] | Define and modify Angle geometry components and templates. | 10 |
| VectorTool Axes | VectorTool <ScenarioPath> <ParentObject> {Action} {Axes | AxesTemplate} <AxesName> [{AxesType} <AxesTypeParams>] | Define and modify Axes geometry components and templates. | 11 |
| VectorTool Plane | VectorTool <ScenarioPath> <ParentObject> {Action} {Plane | PlaneTemplate} <PlaneName> [{PlaneType} <PlaneTypeParams>] | Define and modify Plane geometry components and templates. | 10 |
| VectorTool Point | VectorTool <ScenarioPath> <ParentObject> {Action} {Point | PointTemplate} <PointName> [{PointType} <PointTypeParams>] | Define and modify Point geometry components and templates. | 11 |
| VectorTool System | VectorTool <ScenarioPath> <ParentObject> {Action} {System | SystemTemplate} <SystemName> [{SystemType} <SystemTypeParams>] | Define and modify System geometry components and templates. | 10 |
| VectorTool Vector | VectorTool <ScenarioPath> <ParentObject> {Action} {Vector | VectorTemplate} <VectorName> [{VectorType} <VectorTypeParams>] | Define and modify Vector geometry components and templates. | 11 |
| VectorTool_R | VectorTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about VectorTool components. | 10.1 |
| VectorTool_RM | VectorTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about VectorTool components. | 10.1 |
STK Programming Interface 11.0.1