Description | Example | Return Message | Group

TimeTool_RM

Return information about TimeTool components.

Syntax

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

Related Commands

Description

The TimeTool_RM command can be used to return information about TimeTool components.

Note: The TimeTool_RM command is not valid for CommSystem, Constellation, Planet, or Star objects, or Central Bodies.

{Option} <Parameters> 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 TimeTool_R command to return Details information in a single string.
Times "<ComponentSpec>" Returns the list of times for the specified "<ComponentSpec>". The times are returned in Connect date units.

The Times option is not valid for a template.

Use the TimeTool_R command to return times 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. "Time Instant", Interval, 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 Time component or template specifications.

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

Example

Return information about the specified Interval List:

TimeTool_RM * Details "Satellite/Satellite2 ScalePassList Interval List"

ReturnMessage

Interval List Type: Scaled
Interval List Name: ScalePassList
Interval List Parent: Satellite2
Original Interval List: Satellite2 PassIntervals
Absolute Scale: 60.000000

Example

Return the dependents of the specified Collection of Interval Lists:

TimeTool_RM * Dependency "Satellite/Satellite2 LightingIntervals Collection of Interval Lists"

ReturnMessage

Dependents for Satellite2 LightingIntervals Collection of Interval Lists
   Satellite/Satellite2 LightingIntervals.Umbra Interval List
   Satellite/Satellite2 LightingIntervals.Penumbra Interval List
   Satellite/Satellite2 LightingIntervals.Sunlight Interval List

Example

Return the Times for the specified PassIntervals Interval List:

TimeTool_RM * Times "Satellite/ScenTestSat PassIntervals Interval List"

ReturnMessage

1 Jul 2009 15:00:00.000 1 Jul 2009 16:40:40.375
1 Jul 2009 16:40:40.375 1 Jul 2009 18:21:20.750
1 Jul 2009 18:21:20.750 1 Jul 2009 20:02:01.124
1 Jul 2009 20:02:01.124 1 Jul 2009 21:42:41.499
1 Jul 2009 21:42:41.499 1 Jul 2009 23:23:21.874
1 Jul 2009 23:23:21.874 2 Jul 2009 01:04:02.249
2 Jul 2009 01:04:02.249 2 Jul 2009 02:44:42.623
2 Jul 2009 02:44:42.623 2 Jul 2009 04:25:22.998
2 Jul 2009 04:25:22.998 2 Jul 2009 06:06:03.373
2 Jul 2009 06:06:03.373 2 Jul 2009 07:46:43.748
2 Jul 2009 07:46:43.748 2 Jul 2009 09:27:24.122
2 Jul 2009 09:27:24.122 2 Jul 2009 11:08:04.497
2 Jul 2009 11:08:04.497 2 Jul 2009 12:48:44.872
2 Jul 2009 12:48:44.872 2 Jul 2009 14:29:25.247
2 Jul 2009 14:29:25.247 2 Jul 2009 15:00:00.000

Example

Return Interval components for all objects in the Scenario:

TimeTool_RM * Names Type Interval

ReturnMessage

Scenario/SimpleScen AnalysisInterval Interval
Scenario/SimpleScen AnimationInterval Interval
Scenario/SimpleScen TodayInterval Interval
Aircraft/Aircraft1 AvailabilityTimeSpan Interval
Aircraft/Aircraft1 EphemerisTimeSpan Interval
Place/Place1/Sensor/Sensor1 AvailabilityTimeSpan Interval
Satellite/Satellite1 AvailabilityTimeSpan Interval
Satellite/Satellite1 EphemerisTimeSpan Interval

Example

Return all Installed Time Instant components for Satellite1:

TimeTool_RM * Names Object Satellite/Satellite1 Installed Type "Time Instant"

ReturnMessage

Satellite/Satellite1 AvailabilityStartTime Time Instant
Satellite/Satellite1 AvailabilityStopTime Time Instant
Satellite/Satellite1 EphemerisEpoch Time Instant
Satellite/Satellite1 EphemerisStartTime Time Instant
Satellite/Satellite1 EphemerisStopTime Time Instant
Satellite/Satellite1 EphemerisTimeSpan.Start Time Instant
Satellite/Satellite1 EphemerisTimeSpan.Stop Time Instant

Group Membership

This command belongs to the following group(s):

Area Targets

Chains

Comm

Facilities, Places & Targets

Line Targets

Radar

Scenarios

Sensors

Stars & Planets

Object Tools

Vehicles

Volumetric

VO

VO Objects

Version

10.1

STK Programming Interface 11.0.1