Description | Example | Return Message | Group

CalculationTool_R

Return information about CalculationTool components.

Syntax

CalculationTool_R <ScenarioPath> {Option} [<Parameters>]

Related Commands

Description

The CalculationTool_R command can be used to return information about CalculationTool components.

{Option}	<Parameters>	Description
Exists	[Template] "<ComponentSpec>"	Returns a 1 if the specified "<ComponentSpec>" exists, otherwise 0 will be returned. Use the Template keyword if the component is a template.
Details	[Template] "<ComponentSpec>" [IncludeDescriptions]	Returns information about the component in a single string with newline characters. Use the Template keyword if the component is a template. With the IncludeDescriptions keyword the component type description and user description, if available, will also be returned. Use the CalculationTool_RM command to return information in a list of strings.
Status	"<ComponentSpec>"	Returns one of these strings Computed Computed, can not be cleared Cleared Can not be Computed The Status option is not valid for a template.
{CreateReportStyle \| CreateGraphStyle}	"<ComponentSpec>" [ShowSummary] [{ValueOnly \| RateOnly}] [Element "<ElementName>"...]	Create a permanent report or graph style file for calculation components. The report or graph style file can be used with ReportCreate, Report_RM and GraphCreate commands. Returns the name of the new report or graph style. This command will always create a new style file. If a style file with the same name already exists then a number will be appended to create a unique filename. For example: ElapsedTimeFromStart, ElapsedTimeFromStart1, ElapsedTimeFromStart2. The ShowSummary option is valid for Reports of Scalar Calculation and Parameter Set components only. The {ValueOnly \| RateOnly} options are valid for Reports of Scalar Calculation components only. Specify whether only the Value or only the Rate should be included. Element "<ElementName>" is only valid for and is required for Parameter Set. This parameter can be included several times in one command, but there must be at least one. The Element <ElementName> parameter is used in conjunction with the Parameter Set component name. The component name and element name together must describe one scalar calculation element.
ScalarMinMax	"<ScalarCalcSpec>" [ScenarioUnits] [IncludeAbbrev]	Returns <MinimumValue> <MaximumValue> Returns the minimum and maximum values for the specified Scalar Calculation. The values are returned in internal units. Specify ScenarioUnits to return the values in Scenario units. Specify IncludeAbbrev to include the unit abbreviation.
ScalarSTDMean	"<ScalarCalcSpec>" [ScenarioUnits] [IncludeAbbrev]	Returns <STDValue> <MeanValue> Returns the standard deviation and mean values for the specified Scalar Calculation. The values are returned in internal units. Specify ScenarioUnits to return the values in Scenario units. Specify IncludeAbbrev to include the unit abbreviation.

For information on "<ComponentSpec>" formats see Component Specification.

Example

Determine if the specified Condition exists:

CalculationTool_R * Exists "CentralBody/Earth AfterStart Condition"

ReturnMessage

Returns 1 if the Condition exists, otherwise returns 0

Example

Determine if the specified template Scalar Calculation exists:

CalculationTool_R * Exists Template "Satellite ElapsedTimeFromStart Scalar Calculation"

ReturnMessage

Returns 1 if the Scalar Template exists, otherwise returns 0

Example

Return information about the specified Parameter Set:

CalculationTool_R * Details "Satellite/ScenTestSat Sat2AttColl Parameter Set"

ReturnMessage

Parameter Set Type: Attitude
Parameter Set Name: Sat2AttColl
Parameter Set Parent: ScenTestSat
Axes: ScenTestSat Body
Reference Axes: ScenTestSat J2000

Example

Create a report style for the Scalar Calculation Orbit.Cartesian.X:

CalculationTool_R * CreateReportStyle "Satellite/Satellite1 Orbit.Cartesian.X Scalar Calculation"

ReturnMessage

Returns the name of the new report style:

Orbit.Cartesian.X

Example

Create a report style that will report these elements: "Attitude(Fixed).Euler.121.A" and "Attitude(Fixed).Euler.121.A Rate":

CalculationTool_R * CreateReportStyle "Satellite/Satellite1 Attitude(Fixed) Parameter Set" Element "Euler.121.A" Element "Euler.121.A Rate"

ReturnMessage

Returns the name of the new report style:

Attitude(Fixed)

Example

Create a report style for the Scalar Calculation Orbit.Cartesian.X that displays only the Scalar Value:

CalculationTool_R * CreateReportStyle "Satellite/Satellite1 Orbit.Cartesian.X Scalar Calculation" ValueOnly

ReturnMessage

Returns the name of the new report style:

Orbit.Cartesian.X

Example

To return the minimum and maximum values for the specified Scalar Calculation:

CalculationTool_R * ScalarMinMax "Satellite/Satellite1 Speed Scalar Calculation" IncludeAbbrev

ReturnMessage

Returns the minimum and maximum values in internal units, with the unit abbreviation:

7612.278439 m/sec 7627.122672 m/sec

Example

To return the standard deviation and mean values, in internal units, for the specified Scalar Calculation:

CalculationTool_R * ScalarSTDMean "Satellite/Satellite1 DistanceAlongTrajectory Scalar Calculation"

ReturnMessage

Returns the standard deviation and mean values in internal units:

190003480.184872 329094621.224865

Group Membership

This command belongs to the following group(s):

Area Targets

Comm

Facilities, Places & Targets

Version

STK Programming Interface 11.0.1