Description | Example | Return message | Group

SetConstraint (Vehicles)

Set a constraint for a vehicle

Syntax

SetConstraint <ObjectPath> {ConstraintName} <Parameters>

Related commands

Description

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 constraints for vehicles On and Off and also sets parameters 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.

Basic Constraints

The following basic constraints are valid for facilities, places, targets and most types of vehicles:

{ConstraintName}<Parameters>
AzimuthAngle{Off | Min <Value1> Max <Value2>} [ExcludeIntervals | IncludeIntervals]
AzimuthRate{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
ElevationAngle{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
ElevationRate{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
Range{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
RangeRate{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
AngularRate{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
Altitude{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
PropagationDelay{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
LineOfSight{On | Off}

Both a Min and Max value must be specified when enabling the AzimuthAngle constraint. Otherwise, <value1> is only required if Min is specified and <value2> is only required if Max is specified. If only one is specified, in cases where Min and Max are not both required, the prior setting for the other is maintained.

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.

In addition to the basic constraints above, the TerrainMask constraint is available for facilities, places, targets, aircraft, ground vehicles, and ships only:

{ConstraintName}<Parameters>
TerrainMask{On | Off}

Sun Constraints

The following sun constraints are valid for facilities, places, targets and certain types of vehicles:

{ConstraintName}<Parameters>
SunElevationAngle{Off | Min <Value1> [|] Max <Value2>}
LunarElevationAngle{Off | Min <Value1> [|] Max <Value2>}
LOSSunExclusion{Off | <Value1>}
SunSpecularExclusion{Off | <Value1>}
LOSLunarExclusion{Off | <Value1>}
LOSSunIlluminationAngle{Off | Min <Value1> Max <Value2>}
ThirdBodyObstruction{On | Off}
Lighting{Off | DirectSun | PenumbraDirectSun | PenumbraUmbra | Penumbra | UmbraDirectSun | Umbra}
CbObstruction{<CbName> ...} [ExcludeIntervals | IncludeIntervals]

Both a Min and Max value must be specified when enabling the LOSSunIlluminationAngle constraint.

For the CbObstruction constraint one or more <CbName> can be entered.

In addition to the sun constraints above the SunGroundElevAngle constraint is available for vehicles only:

{ConstraintName}<Parameters>
SunGroundElevAngle{Off | Min <Value1> [|] Max <Value2>}

Temporal Constraints

The following temporal constraints are valid for facilities, places, targets, vehicles, and area targets:

Intervals are defined relative to a clock colocated with the object holding the constraint. These intervals will be shifted by the light time delay associated with a given access computation if the intervals for access are computed relative to a clock located with the other object. For example: If you specify intervals for a Mars-based facility and then compute access from an Earth-based facility to the Mars-based facility, the Mars-based intervals will be shifted by the light time delay so that the signal will arrive at Mars during the desired intervals. This may appear to be confusing since, in this case, the interval reported by the access computation will be transmission times from the Earth-based facility.

{ConstraintName}<Parameters>
Duration{Off | Min <Value1> [|] Max <Value2>}
LocalTime{Off | Min <Value1> Max <Value2>}
GMT{Off | Min <Value1> Max <Value2>}
ApparentTime{Off | Min <Value1> Max <Value2>}
Intervals{Off | Include | Exclude} [{Option}]

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

See table below for a description of {Option}.

For LocalTime, GMT and ApparentTime, both a Min and Max value must be specified when enabling the constraint. Both <Value1> and <Value2> are in units of Duration.

For Intervals, if Off is entered then nothing else should be included on the command.

The SetIntervalsOverwrite option has been deprecated in STK 11.3, if entered it will be treated the same as SetIntervals.

The following table describes the {Option} for the SetConstraint Intervals command.

Only one {Option} can be entered on a command.

"<IntervalFile>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information.

{Option}Description
SetIntervals {IntervalOptions}Set time intervals for the constraint. See table below for a description of SetIntervals {Options}. "<IntervalStart>" and "<IntervalStop>" times should be entered in Connect Date units.
TimeComponent "<TimeComponent>"Enter an Interval or Interval List Time Component.

For information on the syntax of "<TimeComponent>" see Component Specification.

Files {Add "<IntervalFile>"... | Remove "<IntervalFile>"... | RemoveAll}This option allows you to enter multiple interval files to create the intervals constraint. The intervals in the files will be OR'd together. Multiple interval files can follow the Add or Remove keyword.

The following table describes the SetIntervals {Options}.

"<Filename>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information.

SetIntervals {Options}Description
Load "<Filename>"Load the specified interval file. The intervals from the file will replace any existing intervals.
Add <NumIntervalPairs> "<IntervalStart>" "<IntervalStop>" ["<IntervalStart2>" "<IntervalStop2>"...]Add the specified intervals to the interval list.
Replace <NumIntervalPairs> "<IntervalStart>" "<IntervalStop>" ["<IntervalStart2>" "<IntervalStop2>"...]Replace the interval list with the specified intervals.
Delete {All | <NumIntervalPairs> "<IntervalStart>" "<IntervalStop>" ["<IntervalStart2>" "<IntervalStop2>"...]Enter Delete All to remove all intervals; or enter specific intervals to delete.
Import [{Add | Replace}] "<TimeComponent>"Import intervals from the specified Interval or Interval List component.

Use the optional Add or Replace option to specify whether existing intervals should be kept (Add) or replaced. The default is to Replace existing intervals.

For information on the syntax of "<TimeComponent>" see Component Specification.

Advanced Constraints

The following advanced constraints are valid for certain types of vehicles:

{ConstraintName}<Parameters>
GrazingAlt{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
GrazingAngle{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
GroundElevAngle{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
BetaAngle{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
DopplerConeAngle{Off | Min <Value1> [|] Max <Value2>} [ExcludeIntervals | IncludeIntervals]
Background{Off | Ground | Space}
GroundTrack{Off | Ascending | Descending}

Zones Constraints

The following zones constraints are valid for vehicles:

{ConstraintName}<Parameters>
ExclusionZone{Off | <Value1>} [<Value2> <Value3> <Value4>], where <Value2>, <Value3> and <Value4> are used only if <Value1> is used for the first argument. If the first argument is Off, <Value2>, <Value3> and <Value4> aren't valid. The four values represent minimum latitude and longitude, maximum latitude and longitude, respectively.

Multiple exclusion zones can be defined for an object.

InclusionZone{Off | <Value1>} [<Value2> <Value3> <Value4>], where <Value2>, <Value3> and <Value4> are used only if <Value1> is used for the first argument. If the first argument is Off, <Value2>, <Value3> and <Value4> aren't valid. The four values represent minimum latitude and longitude, maximum latitude and longitude, respectively.

The Latitude zone constraint is available for backward compatibility only. The InclusionZone constraint should be used instead.

Latitude and Longitude values are entered in Connect Latitude and Longitude units (default is degrees).

Targeting Constraints

The following constraints are valid for certain types of vehicles:

{ConstraintName}<Parameters>
CrossTrackRange{Off | Min <Value1> [|] Max <Value2>}
InTrackRange{Off | Min <Value1> [|] Max <Value2>}
SquintAngle{Off | Min <Value1> [|] Max <Value2>}

For the SquintAngle constraint, <Value1> and <Value2> should be specified in degrees.

Vector Constraints

The following vector constraints are valid for facilities, places, targets, area targets, planets, stars, Comm objects (receivers and transmitters), radars, sensors, and all types of vehicles:

Multiple vector constraints with the same {ConstraintName} can be added to an object, the "<Angle>", "<Condition>", or "<Vector>" must be unique for each new constraint.

{ConstraintName}<Parameters>
CrdnVectorMag
  • Min <Value1> Max <Value2> "<Vector>"
  • Off [Min <Value1> Max <Value2> "<Vector>"]

Enter Off with no parameters to remove all CrdnVectorMag constraints for the object. Enter Off with parameters to remove a specific CrdnVectorMag constraint.

CrdnAngle
  • Min <Value1> Max <Value2> "<Angle>"
  • Off [Min <Value1> Max <Value2> "<Angle>"]

Enter Off with no parameters to remove all CrdnAngle constraints for the object. Enter Off with parameters to remove a specific CrdnAngle constraint.

CrdnCondition
  • "<Condition>"
  • Off ["<Condition>"]

Enter Off with no parameters to remove all CrdnCondition constraints for the object. Enter Off with "<Condition>" to remove a specific CrdnCondition constraint.

CrdnCondition is not valid for Star objects.

The following format is used to specify the "<Vector>", "<Angle>", or "<Condition>":

"<TruncObjectPath> <CrdnName>"

Specify the truncated path of the object followed by a space and the CrdnName, all in quotes. For example: "Satellite/attSat Velocity", specifies the Velocity vector of attSat. If specifying the Crdn of a central body, include the truncated path of the central body followed by a space and the CrdnName, all in quotes. For example: "CentralBody/Earth NorthPole".

Special Constraints

The following special constraints are valid for all types of vehicles:

{ConstraintName}<Parameters>
ObjectExclusionAngle
  • Off {All | <TruncObjectPath>}

Enter Off All to turn off all ObjectExclusionAngle constraints for the parent object.

Enter Off <TruncObjectPath> to turn off the specified object.

Enter one or more of the following to add or modify ObjectExclusionAngle parameters:

  • <TruncObjectPath>
  • <Angle>
  • {ExcludeIntervals | IncludeIntervals}

Multiple <TruncObjectPath> objects can be added to the same parent object.

<Angle> is the minimum allowable exclusion angle in degrees, between -90.0 and 90.0.

<Angle> and {ExcludeIntervals | IncludeIntervals} are applied to all ObjectExclusionAngle objects for the parent object.

Resolution Constraints

{ConstraintName}<Parameters>
GroundSampleDistance{Off | Min <Value1> [|] Max <Value2>}

The GroundSampleDistance constraint applies to accesses where the other object is a sensor, or child of a sensor.

Plugin Constraints

Plugin constraints are valid for facilities, places, targets, Comm objects (receivers and transmitters), radars, sensors, and all types of vehicles:

Plugin constraints are set using the name of the plugin constraint and its associated minimum and maximum values.

<PluginConstName> {Off | Min <Value> | Max <Value>} [Modify <AttrName> <AttrValue>]

<PluginConstName> is the name of the constraint exactly as it appears on the Plugin Constraints Properties page. Use the Modify option to set the value of the plugin's parameter.

Search/Track Constraints

Search/Track constraints for vehicles are identical to that of radar. Visit Connect help for the SetConstraint (Radar) command for a complete list of valid Search/Track constraints. These constraints will only have an effect on an access if one of the access objects is a radar. This allows you to constrain a radar access using the target object.

SAR Constraints

SAR constraints for vehicles are identical to that of radar. Visit Connect help for the SetConstraint (Radar) command for a complete list of valid SAR constraints. These constraints will only have an effect on an access if one of the access objects is a radar. This allows you to constrain a radar access using the target object.

Examples

To set the maximum angular rate to 6.0 degrees per second for the ERS1 satellite in the current scenario:

SetConstraint */Satellite/ERS1 AngularRate Max 6.0

To turn the azimuth rate constraint off:

SetConstraint */GroundVehicle/GroundVehicle1 AzimuthRate Off

To set the minimum elevation rate to -0.004 degrees per second for GroundVehicle1 in the scenario:

SetConstraint */GroundVehicle/GroundVehicle1 ElevationRate Min -0.004

To set the minimum and maximum range for the ERS1 satellite:

SetConstraint */Satellite/ERS1 Range Min 1000.0 Max 600000.0

To set the local time constraint for the ERS1 satellite:

SetConstraint */Satellite/ERS1 LocalTime Min 01:00:00 Max 03:40:00

Examples

To add two intervals to the temporal constraint interval list:

SetConstraint */Satellite/Sat283 Intervals Include SetIntervals Add 2 "9 Mar 2009 16:30:00.00" "9 Mar 2009 18:28:00.00" "9 Mar 2009 18:42:00.00" "9 Mar 2009 19:30:00.00"

To delete the specified interval from the temporal constraint interval list:

SetConstraint */Satellite/Sat283 Intervals Include SetIntervals Delete 1 "9 Mar 2009 18:42:00.00" "9 Mar 2009 19:30:00.00"

To import the intervals from a Time Component, and add the intervals to any existing intervals:

SetConstraint */Satellite/Sat283 Intervals Include Import Add "Satellite/Sat1 LightingIntervals.Umbra Interval List"

To load the specified interval file:

SetConstraint */Satellite/Sat283 Intervals Include SetIntervals Load "c:\Program Files\STK 9\MyFiles\Mar10.int"

To use a Time Component for the temporal intervals constraint:

SetConstraint */Satellite/Sat283 Intervals Include TimeComponent "Satellite/Sat1 LightingIntervals.Sunlight Interval List"

To add multiple files to the temporal intervals constraint:

SetConstraint */Satellite/Sat283 Intervals Include Files Add "c:\Program Files\STKUser\Mar10.int" "c:\Program Files\STKUser\Aircraft.int"

To add the intervals from the specified Time Component to existing intervals:

SetConstraint */Satellite/Sat283 Intervals Include SetIntervals Import Add "Satellite/Sat1 LightingIntervals.Umbra Interval List"

Examples

Add two CrdnVectorMag constraints to Satellite1, then remove both

SetConstraint */Satellite/Satellite1 CrdnVectorMag Min 10.0 Max 50.0 "Satellite/Satellite1 Earth"
SetConstraint */Satellite/Satellite1 CrdnVectorMag Min 45.0 Max 90.0 "Facility/Facility1 North"
SetConstraint */Satellite/Satellite1 CrdnVectorMag Off

Add two CrdnAngle Constraints, then remove the first one:

SetConstraint */Satellite/Satellite1 CrdnAngle Min 10.0 Max 50.0 "Satellite/Satellite1 SunMoon"
SetConstraint */Satellite/Satellite1 CrdnAngle Min 90.0 Max Off "Facility/Facility1 SunAzimuth"
SetConstraint */Satellite/Satellite1 CrdnAngle Off Min 10.0 Max 50.0 "Satellite/Satellite1 SunMoon"

Examples

Turn off all ObjectExclusionAngle constraints for Satellite212:

SetConstraint */Satellite/Satellite212 ObjectExclusionAngle Off All

Add Satellite1, Facility1, and Satellite2 as Exclusion Objects, and set angle to 23.5 degrees:

SetConstraint */Satellite/Satellite212 ObjectExclusionAngle Satellite/Satellite1
SetConstraint */Satellite/Satellite212 ObjectExclusionAngle Facility/Facility1 23.5 Satellite/Satellite2

Set the angle and Include Intervals for all Object Exclusion Angle constraints on Satellite212:

SetConstraint */Satellite/Satellite212 ObjectExclusionAngle IncludeIntervals 13.2

Return message

Group membership

This command belongs to the following group(s):

Vehicles

Version

11.6