Description | Example | Return Message | Group

SpatialTool_RM

Return information about SpatialTool components.

Syntax

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

Related Commands

Description

The SpatialTool_RM command can be used to return information about Spatial components.

{Option}

Description

Details

[Template] "<ComponentSpec>" [IncludeDescriptions]

Returns information about the component as a list of strings. 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 SpatialTool_R command to return Details information in a single string.

Dependency

"<ComponentSpec>" [{Dependents | Constituents}]

Return the Dependents or Constituents of the specified component. The default type is Dependents.

The Dependency option is not valid for a template.

Names

Object <ObjectTruncPath>	Specify the object to return components for that object, or specify a class to return components or templates for that class or for Central Bodies. Enter Class CentralBody to return components for all Central Bodies, enter Object CentralBody/<CBName> to return components for just the specified central body. Object and Class cannot be entered on the same command. The default is to return components for all objects.
Class {<ClassName> \| CentralBody}
Type {"<Type>"}	Specify the type of component to return, e.g. Volume Grid, Spatial Condition, or Spatial Calculation. The default is to return all component types.
{Installed \| User}	Enter Installed to return only installed components, enter User to return user components. The default is to return both Installed and User components.
Templates	Enter Templates to return templates instead of components. The Class <ClassName> must be entered when requesting Templates!

Return a list of VGT component or template specifications.

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

Example

Return information about the specified Distance Spatial Condition:

SpatialTool_RM * Details "Facility/Facility1 Distance Spatial Calculation"

ReturnMessage

Spatial Calculation Name: Distance
Spatial Calculation Parent: Facility1
Spatial Calculation Type: Distance From Reference
Distance: From Point
Reference Point: Facility1 Center

Example

Return the constituents of the specified Position Spatial Condition:

SpatialTool_RM * Dependency "Satellite/Satellite1 DistanceAhead Spatial Calculation" Constituents

ReturnMessage

Constituents for Satellite1 Distance Spatial Calculation
Satellite/Satellite1 Center Point
   CentralBody/Earth Inertial System
     CentralBody/Earth Center Point
       CentralBody/Earth Orbit
     CentralBody/Earth Inertial Axes
   Satellite/Satellite1 Ephemeris Data
   Satellite/Satellite1 EphemerisEpoch Time Instant
     Satellite/Satellite1 Object
     Scenario/SimpleScen AnalysisInterval Interval
   Satellite/Satellite1 EphemerisTimeSpan Interval
     Satellite/Satellite1 Ephemeris Propagation Interval
     Scenario/SimpleScen AnalysisInterval Interval
   Scenario/SimpleScen AnalysisInterval Interval
Satellite/Satellite1 LocalHorizontal Plane
   Satellite/Satellite1 TopoCentric System
     Satellite/Satellite1 Center Point
       CentralBody/Earth Inertial System
         CentralBody/Earth Center Point
           CentralBody/Earth Orbit
         CentralBody/Earth Inertial Axes
       Satellite/Satellite1 Ephemeris Data
       Satellite/Satellite1 EphemerisEpoch Time Instant
         Satellite/Satellite1 Object
         Scenario/SimpleScen AnalysisInterval Interval
       Satellite/Satellite1 EphemerisTimeSpan Interval
         Satellite/Satellite1 Ephemeris Propagation Interval
         Scenario/SimpleScen AnalysisInterval Interval
       Scenario/SimpleScen AnalysisInterval Interval
     Satellite/Satellite1 TopoCentric Axes
       CentralBody/Earth Fixed Axes
         CentralBody/Earth FrameDefinitions
         CentralBody/Earth Inertial Axes
       Satellite/Satellite1 Position Data
Satellite/Satellite1 Zenith(Detic) Vector
   Satellite/Satellite1 TopoCentric Axes
     CentralBody/Earth Fixed Axes
       CentralBody/Earth FrameDefinitions
       CentralBody/Earth Inertial Axes
     Satellite/Satellite1 Position Data

Example

Return names of Spatial Calculation components for Satellite ScenTestSat:

SpatialTool_RM * Names Object Satellite/ScenTestSat Type "Spatial Calculation"

ReturnMessage

Satellite/ScenTestSat AltitudeDifference Spatial Calculation
Satellite/ScenTestSat Distance Spatial Calculation
Satellite/ScenTestSat DistanceAhead Spatial Calculation
Satellite/ScenTestSat VerticalDistance Spatial Calculation

Example

Return names of Facility Spatial Condition Templates:

SpatialTool_RM * Names Class Facility Type "Spatial Condition" Templates

ReturnMessage

Facility Visibility Spatial Condition

Group Membership

This command belongs to the following group(s):

Area Targets

Comm

Facilities, Places & Targets

Version

STK Programming Interface 11.0.1