Description | Example | Return Message | Group

VectorTool_RM

Return information about VectorTool components.

Syntax

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

Related Commands

Description

The VectorTool_RM command can be used to return information about VectorTool 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 VectorTool_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. Vector, Point, etc. 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 Position Vector:

VectorTool_RM * Details "Satellite/ESP Position Vector"

ReturnMessage

Vector Type: Displacement
Vector Name: Position
Vector Parent: ESP
Origin Point: Earth Center
Destination Point: ESP Center
Apparent: False

Example

Return the dependents of the specified Position Vector:

VectorTool_RM * Dependency "Satellite/Satellite1 Position Vector"

ReturnMessage

Dependents for Satellite1 Position Vector
   Satellite/Satellite1 Velocity Vector
     Satellite/Satellite1 Sat1CBGraze Point
       Satellite/Satellite1 SatToCBGraz Vector
         Satellite/Satellite1 3d Graphics
     Satellite/Satellite1 3d Graphics
     Satellite/Satellite1 VelocityAzimuth Angle
     Satellite/Satellite1 VertFlightPath Angle
   Satellite/Satellite1 Velocity(CBF) Vector
     Satellite/Satellite1 SEET_LorentzForce Vector
   Satellite/Satellite1 VelocityAzimuth Angle
   Satellite/Satellite1 VertFlightPath Angle

Example

Return names of Points for Satellite ESP:

VectorTool_RM * Names Object Satellite/ESP Type Point

ReturnMessage

Satellite/ESP Center Point
Satellite/ESP SubPoint(Centric) Point
Satellite/ESP SubPoint(Detic) Point
Satellite/ESP SunGlint Point

Example

Return names of Facility Axes Templates:

VectorTool_RM * Names Class Facility Type Axes Templates

ReturnMessage

Facility Body Axes
Facility ICRF Axes
Facility J2000 Axes
Facility Model Axes
Facility NorthEastDown Axes
Facility NorthWestUp Axes
Facility RadialCentric Axes
Facility TopoCentric Axes

Group Membership

This command belongs to the following group(s):

Area Targets

Attitude

Comm

Facilities, Places & Targets

Version

10.1

STK Programming Interface 11.0.1