TimeTool_R
Return information about TimeTool components.
Syntax
TimeTool_R <ScenarioPath> {Option} [<Parameters>]
Related commands
Description
The TimeTool_R command can be used to return information about TimeTool components.
The TimeTool_R command is not valid for CommSystem, Constellation, Planet, or Star objects, or Central Bodies.
{Option} | <Parameters> | Description |
---|---|---|
Times | "<ComponentSpec>" | Returns the time(s) for the specified "<ComponentSpec>" as a single string with newline characters. The times are returned in Connect date units.
The Times option is not valid for a template. Use the TimeTool_RM command to return times in a list of strings. |
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 TimeTool_RM command to return information in a list of strings. |
Status | "<ComponentSpec>" | Returns one of these strings
The Status option is not valid for a template. |
{CreateReportStyle | CreateGraphStyle} | "<ComponentSpec>" [ShowSummary] | Create a permanent report or graph style file for time 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. The ShowSummary option is valid for Reports of Interval List and Collection of Interval Lists components only. 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: PassIntervals, PassIntervals1, PassIntervals2. |
For information on "<ComponentSpec>" formats see Component Specification.
Examples
Determine if the specified Interval exists:
Return message
Returns 1 if the Interval exists, otherwise returns 0Examples
Determine if the specified template Time Instant exists:
Return message
Returns 1 if the Time Instant Template exists, otherwise returns 0Examples
Return information about the specified Interval List:
Return message
Interval List Type: Filtered Interval List Name: SatList7 Interval List Parent: ScenTestSat Original Interval List: ScenTestSat AvailabilityIntervals Filter: First Intervals Max Number of Intervals: 2
Examples
Return the Times for the specified PassIntervals Interval List:
Return message
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
Examples
Create a graph style file for the Satellite's LightingIntervals.Sunlight Interval List:
Return message
Returns the name of the new graph style:LightingIntervals.Sunlight
Create a graph using the new style file:
Group membership
This command belongs to the following group(s):
Version
10