Description | Example | Return Message | Group

CalculationTool Parameter Set

Define and modify Parameter Set components and templates.

Syntax

CalculationTool <ScenarioPath> <ParentObject> {Action} {"Parameter Set" | "Parameter SetTemplate"} <ComponentName> [{ParameterSetType} <TypeParams>]

Related Commands

Description

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

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

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

{ParameterSetType} <TypeParams>
"Attitude"
  • Axes "<Axes>"
  • ReferenceAxes "<Axes>"
"Ground Trajectory"
  • Location "<Point>"
  • CentralBody <CBName>
"Orbit"
  • OrbitingPoint "<Point>"
  • CentralBody <CBName>
  • UseCBGravParam {Yes | No}
  • GravParam <Value>
  • UseCBInertialSystem {Yes | No}
  • ReferenceSystem "<System>"

If UseCBGravParam is No, then the value specified by GravParam will be used.

The GravParam <Value> is entered in Scenario units of distance cubed over time squared.

If UseCBInertialSystem is No, then ReferenceSystem can be used to specify a reference system.

"Trajectory"
  • Location "<Point>"
  • ReferenceSystem "<System>"
"Vector"
  • Vector "<Vector>"
  • ReferenceAxes "<Axes>"

For details on the format of a reference component (e.g. "<Point>", "<System>", etc) see Component Specification.

When specifying a reference component or template in the Create or Modify commands the {ComponentType} is implied based on the {ParameterSetType} being created or modified and the {ComponentType} need not be entered. In the example below, "Satellite/ScenTestSat ICRF Axes" is entered as "Satellite/ScenTestSat ICRF", since the command is expecting an Axes.

Example

To create and modify an Attitude Parameter Set:

CalculationTool * Satellite/ScenTestSat Create "Parameter Set" SatAtt1 "Attitude"

CalculationTool * Satellite/ScenTestSat Modify "Parameter Set" SatAtt1 "Attitude" Axes "CentralBody/Earth Fixed" ReferenceAxes "Satellite/ScenTestSat ICRF"

To create and modify an Orbit Parameter Set:

CalculationTool * Satellite/ScenTestSat Create "Parameter Set" SatOrb1 "Orbit" CentralBody Earth

CalculationTool * Satellite/ScenTestSat Modify "Parameter Set" SatOrb1 "Orbit" OrbitingPoint "Satellite/ScenTestSat Center" UseCBInertialSystem No ReferenceSystem "Satellite/ScenTestSat Body"

CalculationTool * Satellite/ScenTestSat Modify "Parameter Set" SatOrb1 "Orbit" UseCBGravParam No GravParam "213141.9"

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