Description | Example | Return Message | Group

SetConstraint (Comm)

Set a constraint for a receiver, transmitter or antenna

Syntax

SetConstraint <ObjectPath> {ConstraintName} <Parameters>

Related Commands

Description

Warning: Caution should be exercised when turning a constraint Off, in that any previously set constraint values may be lost. These cannot be recovered when the constraint is subsequently turned On.

The SetConstraint command turns receiver, transmitter or antenna constraints On and Off and also sets values for the constraints. The following Tables list valid values for {ConstraintName} as well as the parameters accepted for each. Only one constraint can be set with each SetConstraint command. All angle, latitude and longitude input values are entered in degrees.

Comm Constraints

The following Comm constraints are valid for receivers and transmitters:

{ConstraintName} Parameters
RcvdIsotropicPower {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are in dBW.
PowerAtReceiverInput {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are in dBW.
DopplerShift {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are in GHz.
Frequency {Off | Min <Value1> | Max <Value2> | Band <Value3>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are in GHz and <Value3> is L, S, C, X, KU, KA, K, Q, V, or custom.
C/N {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB
FluxDensity {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dBW/m^2
C/No {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB*Hz
Eb/No {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB
BitErrorRate {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
PolRelAngle {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in degrees
LinkEIRP {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dBW
LinkMargin {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
G/T {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB/K

The following Comm constraints are valid for receivers only:

{ConstraintName} Parameters
CommPlugin {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals] "<ConstraintFileName>"

<Value1> and <Value2> are entered in dB. <ConstraintFileName> is the script file, created in Perl, VBScript or MATLAB, that defines the constraint.

The ExcludeIntervals option allows you to exclude the time intervals during which the constraint is satisfied. Specifying IncludeIntervals turns off this option and the times during which the constraint is satisfied will be used.

Noise Constraints

Noise Constraints are available for receivers only.

{ConstraintName} Parameters
NoiseTemperature {Off | Min <Value1> [|] Max <Value2>} [{NoiseOptions}] [ExcludeIntervals | IncludeIntervals]

where <Value1> and <Value2> are in Kelvin.

The following are valid {NoiseOptions}:

  • UseComponents {On | Off}
  • UseEarth {On | Off}
  • UseSun {On | Off}
  • UseAtmosphere {On | Off}
  • UseUrbanTerrestrial {On | Off}
  • UseRain {On | Off}
  • UseCosmicBackground {On | Off}
  • UseCloudFog {On | Off}
  • UseTropoScint {On | Off}
  • UseExternal {On | Off}

Interference Constraints

The Interference constraints are valid for receivers and transmitters:

{ConstraintName} Parameters
PowerFluxDensity {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dBW/m^2
C/No+Io {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB*Hz
J/S {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB
C/N+I {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB
C/I {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB
TotalRcvdRFPower {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dBW
TotalPwrAtRcvrInput {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dBW
Eb/No+Io {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB
BER+I {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
DeltaT/T {Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals], where <Value1> and <Value2> are entered in dB

Refraction Constraints

The Refraction constraints are not valid in STK 8 and later. This includes SetConstraint {RefractedRange | RefractedElevation | RefractedLineOfSight}.

Note: Use the Refraction command instead.

Basic Constraints

Basic constraints for receivers, transmitters and antennas vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Facility, Place & Target), SetConstraint (Sensor) or the SetConstraint (Vehicles) commands for a complete list of valid basic constraints.

Sun Constraints

Sun constraints for receivers, transmitters and antennas vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) and the SetConstraint (Sensor) commands for a complete list of valid sun constraints.

Temporal Constraints

The following Temporal constraint is available for receivers and transmitters:

{ConstraintName} Parameters
ProcessDelay {Off | Duration <Value1>} where <Value1> is entered in seconds between 0.0 and 86400.0 seconds. The Process Delay constraint will be turned off if the duration value is set to 0.0.

Other Temporal constraints for receivers, transmitters and antennas vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid temporal constraints.

Advanced Constraints

Advanced constraints for receivers and transmitters vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid advanced constraints.

Zones Constraints

Zones constraints for receivers, transmitters and antennas vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of available zones constraints.

Targeting Constraints

Targeting constraints for receivers and transmitters vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid targeting constraints.

Vector Constraints

Vector constraints for receivers, transmitters and antennas vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid vector constraints.

Special Constraints

Special constraints for receivers, transmitters and antennas vary according to the valid constraints for the parent object. Parent objects can be facilities and targets, vehicles or sensors. Visit Connect help for the SetConstraint (Vehicles) command for a complete list of valid special constraints.

Plugin Constraints

Plugin constraints for receivers, transmitters and antennas are identical to that of vehicles. Visit Connect help for the SetConstraint (Vehicles) command for help setting plugin constraints.

Example

To set a maximum flux density of 10,000 dB(W/m squared) for the TestReceiver:

SetConstraint */Facility/Customer/Receiver/TestReceiver FLUXDENSITY MAX 10000

To set a CommPlugin constraint, using the specified script file:

SetConstraint */Aircraft/Aircraft1/Receiver/Receiver2 CommPlugin Min 0.4 Max 0.8 IncludeIntervals "C:\Documents and Settings\stktest\My Documents\STK 9\LatencyConstraint_tms_changes\VB_CommConstraint.vbs"

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Comm

Version

10.1

STK Programming Interface 11.0.1