Description | Example | Return Message | Group

VectorTool_R

Return information about VectorTool components.

Syntax

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

Related Commands

Description

The VectorTool_R command can be used to return information about VectorTool 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 VectorTool_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.

    ConvertSystem"<FromSystemSpec>" "<ToSystemSpec>" {TimeInstant} <x> <y> <z> [<xv> <yv> <zv>]Convert a position/velocity from one system to another at the specified time instant. <x>, <y>, and <z> values are entered in Connect distance units. <xv>, <yv>, and <zv> values are optional and if entered are in Connect distance units / second.
    ConvertAxes"<FromAxesSpec>" "<ToAxesSpec>" {TimeInstant} <x> <y> <z> [<xv> <yv> <zv>]Convert a position/velocity from one axes to another at the specified time instant. <x>, <y>, and <z> values are entered in Connect distance units. <xv>, <yv>, and <zv> values are optional and if entered are in Connect distance units / second.

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

    For valid {TimeInstant} values see Time Options.

    Example

    Determine if the specified Axes exists:

    VectorTool_R * Exists "Satellite/Satellite1 J2000 Axes"

    ReturnMessage

    Returns 1 if the Axes exists, otherwise returns 0

    Example

    Determine if the specified template Axes exists:

    VectorTool_R * Exists Template "Satellite Body Axes"

    ReturnMessage

    Returns 1 if the Axes Template exists, otherwise returns 0

    Example

    Return information about the specified Position Vector:

    VectorTool_R * 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

    Convert the specified Position from Earth Inertial System to Earth Fixed System:

    VECTORTOOL_R * ConvertSystem "CentralBody/Earth Inertial" "CentralBody/Earth Fixed" "29 Sep 2013 16:00:00.000" -4844418.113 632169.241 4086605.212

    ReturnMessage

    1216469.934078 -4736121.718381 4081386.888024

    Convert the specified Position and Velocity from Satellite Body Axes to Satellite LVLH:

    VectorTool_R * ConvertAxes "Satellite/Satellite1 Body" "Satellite/Satellite1 LVLH" "5 Apr 2013 16:02:00.000" 2429147.990 -6402503.478 644947.940 4410.004618 2210.635488 5335.388073

    ReturnMessage

    -701493.175561 2378921.472598 6415404.004448 2639.445311 572.556440 76.298556

    Group Membership

    This command belongs to the following group(s):

    Area Targets

    Attitude

    Comm

    Facilities, Places & Targets

    Line Targets

    Radar

    Scenarios

    Sensors

    Stars & Planets

    Object Tools

    Vehicles

    VO

    VO Objects

    Version

    10.1