Description | Example | Return Message | Group

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

CalculationTool

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.

Note: 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 it's parameters.

{ConditionSetType}

"Scalar Thresholds"

Scalar "<CalcScalar>"
Thresholds {ThresholdOptions}

{ThresholdOptions}
ConsiderAbove {Yes \| No}
ConsiderBelow {Yes \| No}
Explicit <Value> <Label>
StartStop <Start> <Stop> <Step>
Remove <Value>
RemoveAll

If the dimension of the Scalar is Time, Distance, Angle, or Date, then level <Value>, <Start>, <Stop>, <Step> is entered in Connect units. Otherwise, they 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}.

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.

Example

To create and modify a Scalar Thresholds Condition Set:

CalculationTool * Satellite/ScenTestSat Create "Condition Set" SatCalc21 "Scalar Thresholds"

CalculationTool * Satellite/ScenTestSat Modify "Condition Set" SatCalc21 "Scalar Thresholds" Scalar "Satellite/ScenTestSat Orbit.Cartesian.X" Thresholds ConsiderAbove No

CalculationTool * Satellite/ScenTestSat Modify "Condition Set" SatCalc21 "Scalar Thresholds" Thresholds RemoveAll StartStop 100 3000 200

CalculationTool * Satellite/ScenTestSat Modify "Condition Set" SatCalc21 "Scalar Thresholds" Thresholds Explicit 345 "345 Test" Explicit 300 "Duplicate" Explicit 5000 "New Last Value"

To create, modify and then delete a Scalar Thresholds Condition Set for Earth:

CalculationTool * CentralBody/Earth Create "Condition Set" EarthCondition5 "Scalar Thresholds"

CalculationTool * CentralBody/Earth Modify "Condition Set" EarthCondition5 "Scalar Thresholds" Scalar "Satellite/ScenTestSat Orbit.Cartesian.Z"

CalculationTool * CentralBody/Earth Delete "Condition Set" EarthCondition5