Description | Example | Return message | Group

SetConstraint (Vehicles)

Set an access constraint for a vehicle

Syntax

SetConstraint <ObjectPath> {ConstraintName} <Parameters>

Related commands

SetConstraintOptions

Description

You should exercise caution when turning a constraint off, in that any previously set constraint values may be lost. You cannot recover these values when you turn the constraint back on.

Use the SetConstraint command to turn constraints for vehicles on and off and also to set parameters for these constraints. The following tables list valid values for {ConstraintName} as well as the parameters accepted for each. You can only set one constraint with each SetConstraint command.

Enter all angle, latitude, and longitude input values in degrees.

Basic constraints

The following Basic constraints are valid for most types of vehicles:

{ConstraintName}	<Parameters>
ElevationAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
ElevationRate	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
Lighting	{Off \| DirectSun \| PenumbraDirectSun \| PenumbraUmbra \| Penumbra \| UmbraDirectSun \| Umbra}
LineOfSight	{On \| Off} [ExcludeIntervals \| IncludeIntervals]
Range	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
RangeRate	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]

You must enter both a Min and Max value when enabling the AzimuthAngle constraint. Otherwise, <value1> is only required if you specify Min and <value2> is only required if you specify Max. If you only specify one, in cases where Min and Max are not both required, STK maintains the prior setting for the other.

Use the ExcludeIntervals option to exclude the time intervals during which the constraint is satisfied. Specifying IncludeIntervals turns off this option, and so STK would use the times during which the constraint is satisfied.

In addition to the Basic constraints above, the TerrainMask constraint is available for aircraft, ground vehicles, and ships:

{ConstraintName}	<Parameters>
TerrainMask	{On \| Off} [ExcludeIntervals \| IncludeIntervals]

Angle constraints

The following Angle constraints are valid for most types of vehicles:

{ConstraintName}	<Parameters>
AngularRate	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
AzimuthAngle	{Off \| Min <Value1> Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
AzimuthRate	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
CentralAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
DopplerConeAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
ElevationAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
ElevationRate	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
GrazingAlt	{Off \| Min <Value1> [\|] Max <Value2>} [ComputeBeyondTarget {On \| Off}] [ExcludeIntervals \| IncludeIntervals]
GrazingAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
GroundElevAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
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} {ModifyAll \| ModifySpecified} You can add two or more <TruncObjectPath> objects to the same parent object. <Angle> is the minimum allowable exclusion angle in degrees, between -90.0 and 90.0. ModifyAll is the default and indicates that the angle and Exclude/Include Intervals parameters in the command affect all ObjectExclusionAngle constraints for all objects, not just the object(s) specified in the command. ModifySpecified applies the parameters only to the object(s) in the command.
SquintAngle	{Off \| Min <Value1> [\|] Max <Value2>} For the SquintAngle constraint, enter <Value1> and <Value2> in degrees.

Analysis Workbench (AWB) 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:

You can add two or more vector constraints with the same {ConstraintName} to an object. The "<Angle>", "<Condition>", and "<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.
CrdnCalcScalar	Min <Value1> Max <Value2> "<CalcScalar>" Off [Min <Value1> Max <Value2> "<CalcScalar>"] Enter Off with no parameters to remove all CrdnCalcScalar constraints for the object. Enter Off with parameters to remove a specific CrdnCalcScalar constraint.

Use the following format to specify the "<Vector>", "<Angle>", "<Condition>", or "<CalcScalar>":

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

Central Body constraints

The following Central Body constraints are valid for certain types of vehicles:

{ConstraintName}	<Parameters>
BetaAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
CbObstruction	{<CbName> ...} [ExcludeIntervals \| IncludeIntervals] For the CbObstruction constraint, you can enter one or more values for <CbName>.
LOSCbExclusion	Off {<CbName>} Off <CbName> turns off all LOSCbExclusion constraints with <CbName>. Off by itself turns off all LOSCbExclusion constraints. <CbName> <Angle> [ExcludeIntervals \| IncludeIntervals] Modifies all existing LOSCbExclusion constraints with <CbName> if they exist or adds a new LOSCbExclusion constraint with <CbName>.
LOSLunarExclusion	{Off \| <Value1>} [ExcludeIntervals \| IncludeIntervals]
LOSSunExclusion	{Off \| <Value1>} [ExcludeIntervals \| IncludeIntervals]
LOSSunIlluminationAngle	{Off \| Min <Value1> Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
LunarElevationAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
SunElevationAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
SunGroundElevAngle	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
SunSpecularExclusion	{Off \| <Value1>} [ExcludeIntervals \| IncludeIntervals]
ThirdBodyObstruction	{On \| Off} [ExcludeIntervals \| IncludeIntervals]

You must enter both a Min and Max value when enabling the LOSSunIlluminationAngle constraint.

This ThirdBodyObstruction constraint is deprecated as of STK 12.9. Please use the CbObstruction constraint instead.

Geometry constraints

The following Geometry constraints are valid for most types of vehicles:

{ConstraintName}	<Parameters>
3DTilesMask	{On \| Off} [ExcludeIntervals \| IncludeIntervals]
Altitude	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
CentralDistance	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
CrossTrackRange	{Off \| Min <Value1> [\|] Max <Value2>}
GroundSampleDistance	{Off \| Min <Value1> [\|] Max <Value2>} The GroundSampleDistance constraint applies to accesses where the other object is a sensor or child of a sensor.
InTrackRange	{Off \| Min <Value1> [\|] Max <Value2>}
PropagationDelay	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
Range	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]
RangeRate	{Off \| Min <Value1> [\|] Max <Value2>} [ExcludeIntervals \| IncludeIntervals]

In addition to the Geometry constraints above, the Background and GrazingAltitude constraints are available for all airborne vehicles and the GroundTrack constraint is available for satellites, missiles, and launch vehicles:

{ConstraintName}	<Parameters>
Background	{Off \| Ground \| Space}
GrazingAltitude	{Off \| Min <Value1> [\|] Max <Value2>} [Off \| ComputeBeyondTarget] [ExcludeIntervals \| IncludeIntervals]
GroundTrack	{Off \| Ascending \| Descending}

Plugin constraints

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

Set plugin constraints 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.

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>
ApparentTime	{Off \| Min <Value1> Max <Value2>}
Duration	{Off \| Min <Value1> [\|] Max <Value2>}
GMT	{Off \| Min <Value1> Max <Value2>}
Intervals	{Off \| Include \| Exclude} [{Option}] Use the Exclude option to exclude the time intervals during which the constraint is satisfied. Specifying Include turns off this option, and so STK will use the times during which the constraint is satisfied. See the table below for a description of {Option}.
LocalTime	{Off \| Min <Value1> Max <Value2>}

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

For Intervals, if you enter Off, then do not include anything else in the command.

The SetIntervalsOverwrite option was deprecated as of STK 11.3. If you enter it, STK will treat it the same as SetIntervals.

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

You can only enter one {Option} in 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 the time intervals for the constraint. See the table below for a description of SetIntervals {Options}. Enter "<IntervalStart>" and "<IntervalStop>" times in Connect Date units.
TimeComponent "<TimeComponent>"	Enter an Interval, Interval List, or Collection of Interval Lists time component. For information on the syntax of "<TimeComponent>", see Component Specification.
Files {Add "<IntervalFile>"... \| Remove "<IntervalFile>"... \| RemoveAll}	Use this option to enter two or more interval files to create the intervals constraint. The intervals in the files will be OR'd together. You can have two or more interval files 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, Interval List, or Collection of Interval Lists time component. (optional) Use the 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.

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. You can define two or more exclusion zones for an object.
InclusionZone	{Off \| <Value1>} [<Value2> <Value3> <Value4>], where STK uses <Value2>, <Value3>, and <Value4> only if you enter <Value1> as the first argument. If the first argument is Off, <Value2>, <Value3>, and <Value4> aren't valid. The four values represent minimum latitude, minimum longitude, maximum latitude, and maximum longitude, respectively.

The Latitude zone constraint is available for backward compatibility only. You should use the InclusionZone constraint instead.

Enter latitude and longitude values in Connect latitude and longitude units (default is degrees).

Multifunction Radar and Multifunction Radar Jamming constraints

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

Radar SearchTrack and Radar SearchTrack Jamming constraints

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

Radar SAR and Radar SAR Jamming constraints

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

SEET constraints

SEET constraints apply to satellites, missiles, and launch vehicles. Visit Connect help for the SetConstraint (SEET) command for a complete list of valid SEET constraints.

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

Set a central body exclusion angle on a vehicle:

SetConstraint */Vehicle/Vehicle1 CBExclusionAngle 45

Examples

To turn off all LOSCbExclusion constraints with central body set to Mars:

SetConstraint */Satellite/Satellite1 LOSCbExclusion Off Mars

To add an LOSCbExclusion constraint with central body set to Mars, or modify an existing LOSCbExclusion constraint with central body set to Mars, such that the exclusion angle is 15 degrees:

SetConstraint */Satellite/Satellite1 LOSCbExclusion Mars 15

Return message

Group membership

This command belongs to the following group(s):

Vehicles

Version

12.9