Description | Example | Return Message | Group

CalculationTool Condition

Define and modify Condition components and templates.

Syntax

CalculationTool <ScenarioPath> <ParentObject> {Action} {"Condition" | "ConditionTemplate"} <ComponentName> [{ConditionType} <TypeParams>]

Related Commands

Description

The "CalculationTool Condition" command is used to add, modify and delete Condition 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 "ConditionTemplate" keyword must be entered.

Note: The Condition 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 {ConditionType} [<TypeParams>] <TypeParams> are optional, except where noted below. If no <TypeParams> are specified, default values are used.
Modify {ConditionType} <TypeParams> The values <ComponentName> {ConditionType} must define an existing Condition component or template. The {ConditionType} 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 {ConditionType} can be specified on a command line, except where indicated.

The following table describes each Condition type and it's parameters.

{ConditionType} <TypeParams>
"Scalar Bounds"
  • Scalar "<CalcScalar>"
  • Operation {AboveMinimum | BelowMaximum | BetweenMinMax | OutsideMinMax}
  • Minimum <Value>
  • Maximum <Value>

If the dimension of the Scalar is Time, Distance, Angle or Date, then Minimum and Maximum <Value> is entered in Connect units. Otherwise, <Value> is entered in Scenario units.

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 Bounds Condition:

CalculationTool * Satellite/ScenTestSat Create "Condition" SatCondition1 "Scalar Bounds"

CalculationTool * Satellite/ScenTestSat Modify "Condition" SatCondition1 "Scalar Bounds" Operation OutsideMinMax Minimum 1200.0 Maximum 6600.0

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

CalculationTool * CentralBody/Earth Create "Condition" EarthCondition5 "Scalar Bounds"

CalculationTool * CentralBody/Earth Modify "Condition" EarthCondition5 "Scalar Bounds" Scalar "Satellite/ScenTestSat SatVec1.Cartesian.Z"

CalculationTool * CentralBody/Earth Delete "Condition" EarthCondition5

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Area Targets

Comm

Facilities, Places & Targets

Line Targets

Radar

Scenarios

Sensors

Stars & Planets

Object Tools

Vehicles

VO

VO Objects

Version

10

STK Programming Interface 11.0.1