CalculationTool Condition Set
Define and modify Condition Set components and templates.
Syntax
CalculationTool <ScenarioPath> <ParentObject> {Action} {"Condition Set" | "Condition SetTemplate"} <ComponentName> [{ConditionType} <TypeParams>]
Related commands
Description
The "CalculationTool Condition Set" command is used to add, modify and delete Condition Set components and templates.
For a component object the <ParentObject> is a truncated object path or a Central Body path.
For a template the <ParentObject> is an STK class name, and the "Condition SetTemplate" keyword must be entered.
The Condition Set component type is not valid for Star objects.
The following table provides a description of {Action} values and the applicable parameters:
| {Action} | Parameters | Description |
|---|---|---|
| Create | {ConditionSetType} [<TypeParams>] | <TypeParams> are optional, except where noted below. If no <TypeParams> are specified, default values are used. |
| Modify | {ConditionSetType} <TypeParams> | The values <ComponentName> {ConditionSetType} must define an existing Condition Set component or template. The {ConditionSetType} can not be modified. <TypeParams> are required. |
| Delete | N/A | Delete the component or template identified by <ComponentName> |
Any or all of the <TypeParams> for an {ConditionSetType} can be specified on a command line, except where indicated.
The following table describes each Condition type and its parameters.
| {ConditionSetType} | <TypeParams> |
|---|---|
| "Scalar Thresholds" |
|
The Scalar determines the dimension of the threshold values and should be set before setting any threshold values.
When a Scalar is set any existing threshold values may be removed.
Threshold options are:
| {ThresholdOptions} | Description |
|---|---|
| ConsiderAbove {Yes | No} | Enter Yes to consider a condition above the highest threshold. This option is ignored, and set to No, if the dimension of the Scalar is Angle. |
| ConsiderBelow {Yes | No} | Enter Yes to consider a condition below the highest threshold. This option is ignored, and set to No, if the dimension of the Scalar is Angle. |
| Explicit <Value> "<Label>" | Set a specific value for a threshold, including a label. |
| StartStop <Start> <Stop> <Step> | Set a series of threshold values. |
| Remove <Value> | Remove a specific threshold value. |
| RemoveAll | Remove all threshold values. |
If the dimension of the Scalar is Time, Distance, or Date, then threshold values, <Value>, <Start>, <Stop>, and <Step>, are entered in Connect units. If the dimension of the Scalar is Angle, then threshold values are entered in Degrees. Otherwise, threshold values are entered in Scenario units.
Explicit and Remove options can be entered multiple times on a command line. Remove and RemoveAll will be processed before Explicit or StartStop on a single command line. Duplicate threshold values will not be entered.
If Scalar "<CalcScalar>" is included on the command line it should be before Thresholds {ThresholdOptions}.
If the dimension of the Scalar is Angle, then ConsiderAbove and ConsiderBelow options will be ignored and they will be set to false.
For details on the format of a reference component (e.g. "<CalcScalar>") see Component Specification.
When specifying a reference component or template in the Create or Modify commands the {ComponentType} is implied based on the {ConditionType} being created or modified and the {ComponentType} need not be entered. In the last example below, "Satellite/ScenTestSat SatVec1.Cartesian.Z" can be entered instead of "Satellite/ScenTestSat SatVec1.Cartesian.Z Scalar Calculation", since the command is expecting a Scalar Calculation.
Examples
To create a Scalar Thresholds Condition Set:
To specify a Scalar for the Condition Set:
To remove all thresholds from the Condition Set, and then add new threshold values:
To add three explicit thresholds (including one duplicate) to the Condition Set:
To create, modify and then delete a Scalar Thresholds Condition Set for Earth:
Return message
Group membership
This command belongs to the following group(s):
Version
11.5