SetConstraint (Vehicles)
Set a constraint for a vehicle
Syntax
SetConstraint <ObjectPath> {ConstraintName} <Parameters>
Related commands
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.
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. 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 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} [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 facilities, places, targets, aircraft, ground vehicles, and ships:
| {ConstraintName} | <Parameters> |
|---|---|
| TerrainMask | {On | Off} [ExcludeIntervals | IncludeIntervals] |
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} [ExcludeIntervals | IncludeIntervals] |
| Lighting | {Off | DirectSun | PenumbraDirectSun | PenumbraUmbra | Penumbra | UmbraDirectSun | Umbra} |
| CbObstruction | {<CbName> ...} [ExcludeIntervals | IncludeIntervals] |
You must enter both a Min and Max value when enabling the LOSSunIlluminationAngle constraint.
For the CbObstruction constraint, you can enter one or more values for <CbName>.
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}] 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}. |
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.
| {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 or Interval List 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}.
| 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.
(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. |
Advanced Constraints
The following advanced constraints are valid for certain types of vehicles:
| {ConstraintName} | <Parameters> |
|---|---|
| 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] |
| 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.
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).
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, enter <Value1> and <Value2> 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:
You can add two or more vector constraints with the same {ConstraintName} to an object. The "<Angle>", "<Condition>", or "<Vector>" must be unique for each new constraint.
| {ConstraintName} | <Parameters> |
|---|---|
| CrdnVectorMag |
Enter Off with no parameters to remove all CrdnVectorMag constraints for the object. Enter Off with parameters to remove a specific CrdnVectorMag constraint. |
| CrdnAngle |
Enter Off with no parameters to remove all CrdnAngle constraints for the object. Enter Off with parameters to remove a specific CrdnAngle constraint. |
| CrdnCondition |
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 |
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".
Special Constraints
The following special constraints are valid for all types of vehicles:
| {ConstraintName} | <Parameters> |
|---|---|
| ObjectExclusionAngle |
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:
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. <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:
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.
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 enables 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 enables 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:
To turn the azimuth rate constraint off:
To set the minimum elevation rate to -0.004 degrees per second for GroundVehicle1 in the scenario:
To set the minimum and maximum range for the ERS1 satellite:
To set the local time constraint for the ERS1 satellite:
Examples
To add two intervals to the temporal constraint interval list:
To delete the specified interval from the temporal constraint interval list:
To import the intervals from a Time Component, and add the intervals to any existing intervals:
To load the specified interval file:
To use a Time Component for the temporal intervals constraint:
To add multiple files to the temporal intervals constraint:
To add the intervals from the specified Time Component to existing intervals:
Examples
Add two CrdnVectorMag constraints to Satellite1, then remove both
Add two CrdnAngle Constraints, then remove the first one:
Examples
Turn off all ObjectExclusionAngle constraints for Satellite212:
Add Satellite1, Facility1, and Satellite2 as Exclusion Objects, and set angle to 23.5 degrees:
Set the angle and Include Intervals for all Object Exclusion Angle constraints on Satellite212:
Return message
Group membership
This command belongs to the following group(s):
Version
11.6