Description | Example | Return message | Group

CalculationTool

Define coordinate systems and elements used in constructing them, including templates.

Syntax

CalculationTool <ScenarioPath> {Options}

Related commands

Description

The CalculationTool command enables you to define, manipulate and analyze components that produce time-varying computational results.

The CalculationTool command is not valid for Chain, CommSystem, Constellation, CoverageDefinition, or Star objects.

{Options}Description
Compute "<ComponentSpec>"Compute the Calculation component. This command will Nack if the component is already computed or cannot be computed.

To get the Compute/Clear status of a Calculation component use the CalculationTool_R command with the Status option.

The Compute option is not valid for a template.

Clear "<ComponentSpec>"Clear the Calculation component.This command will Nack if the component is already cleared or cannot be cleared.

To get the Compute/Clear status of a Calculation component use the CalculationTool_R command with the Status option.

The Clear option is not valid for a template.

Export "<Filename>" "<ComponentSpec>"... Export the specified components to a file.

"<Filename>" is the file that will be written, it should have the extension .awb. If the file already exists it will be overwritten.

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

"<ComponentSpec>" is the name of a component to be exported. This parameter can be entered multiple times on the command line.

All components exported to one file must have the same parent.

Import <TruncObjectPath> "<Filename>"Import the components from the specified "<Filename>".

<TruncObjectPath> specifies the parent of the imported components.

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

Rename "<ComponentSpec>" <NewName>Rename the specified Calculation component to the new name.
RenameTemplate "<TemplateSpec>" <NewName>Rename the specified Calculation template to the new name.
Duplicate "<ComponentSpec>" [<NewName>]Duplicate the specified Calculation component using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate component.
DuplicateTemplate "<TemplateSpec>" [<NewName>]Duplicate the specified Calculation template using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate template.
UserDescription "<ComponentSpec>" "<Description>"Add a user description to the specified Calculation component or template.

If "<Description>" is more than 300 characters it will be truncated to 300.

The user description cannot be changed on the following read-only items: component from template, installed components and templates, and embedded components.

{Create | Modify | Delete}

Follow these links for details to using the CalculationTool command to Create, Modify and Delete Calculation components and templates.

CalculationTool Scalar CalculationCalculationTool ConditionCalculationTool Condition SetCalculationTool Parameter Set

For details on the format of "<ComponentSpec>" see Component Specification.

Examples

To compute and then clear a Calculation Parameter Set:

CalculationTool * Compute "Satellite/ScenTestSat Orbit Parameter Set"
CalculationTool * Clear "Satellite/ScenTestSat Orbit Parameter Set"

Examples

To create and modify a "Constant" Scalar Calculation component:

CalculationTool * Satellite/ScenTestSat Create "Scalar Calculation" SatScalar11 "Constant"
CalculationTool * Satellite/ScenTestSat Modify "Scalar Calculation" SatScalar11 "Constant" Value 45.6213 Dimension Angle

Examples

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

Examples

Rename the specified Parameter Set component to TestOName and then duplicate it, allowing STK to name the duplicated component:

CalculationTool * Rename "Satellite/Satellite2 SpecialSet1 Parameter Set" TestOName
CalculationTool * Duplicate "Satellite/Satellite2 TestOName Parameter Set"

Rename the specified Scalar template:

CalculationTool * RenameTemplate "Facility SclrAngle Scalar Calculation" 30DegAngle

Examples

Add a user description to a Scalar template:

CalculationTool * UserDescription "Facility 30DegAngle Scalar Calculation" "The thirty degree facility elevation angle template."

Add a user description to a Parameter Set component:

CalculationTool * UserDescription "Satellite/Satellite2 TestOName Parameter Set" "My very special Parameter Set component."

Return 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

11.5