TimeTool
Define components defining instances or intervals of time.
Syntax
TimeTool <ScenarioPath> {Options}
Related Commands
Description
The TimeTool command enables you to define instances, intervals of time, time arrays and collections of intervals. These user-created structures and elements can then be used in STK for reporting and graphing as well as 2D and 3D graphic displays.
The TimeTool command is not valid for CommSystem, Constellation, Planet, or Star objects, or Central Bodies.
Valid {Options} are described here.
| {Options} | Description |
|---|---|
| Compute "<ComponentSpec>" | Compute the Time component. This command will Nack if the component is already computed or cannot be computed.
To get the Compute/Clear status of a Time component use the TimeTool_R command with the Status option. The Compute option is not valid for a template. |
| Clear "<ComponentSpec>" | Clear the Time component.This command will Nack if the component is already cleared or cannot be cleared.
To get the Compute/Clear status of a Time component use the TimeTool_R command with the Status option. The Clear option is not valid for a template. |
| Export "<Filename>" "<ComponentSpec>"... | Export the specified components to a file.
"<Filename>" is the file that will be written, it should have the extension .awb. If the file already exists it will be overwritten. "<FilePath>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information. "<ComponentSpec>" is the name of a component to be exported. This parameter can be entered multiple times on the command line. All components exported to one file must have the same parent. |
| Import <TruncObjectPath> "<Filename>" | Import the components from the specified "<Filename>".
<TruncObjectPath> specifies the parent of the imported components. "<Filename>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information. |
| Rename "<ComponentSpec>" <NewName> | Rename the specified Time component to the new name. |
| RenameTemplate "<TemplateSpec>" <NewName> | Rename the specified Time template to the new name. |
| Duplicate "<ComponentSpec>" [<NewName>] | Duplicate the specified Time component using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate component. |
| DuplicateTemplate "<TemplateSpec>" [<NewName>] | Duplicate the specified Time template using the <NewName>, if entered. If <NewName> is not entered then STK will create a unique name for the duplicate template. |
| UserDescription "<ComponentSpec>" "<Description>" | Add a user description to the specified Time component or template.
If "<Description>" is more than 300 characters it will be truncated to 300. The user description cannot be changed on the following read-only items: component from template, installed components and templates, and embedded components. |
| {Create | Modify | Delete} | Follow these links for details to using the TimeTool command to Create, Modify and Delete Time components and templates. TimeTool Time InstantTimeTool Interval TimeTool Interval List TimeTool Time Array TimeTool Collection of Interval Lists |
For details on the format of "<ComponentSpec>" see Component Specification.
Example
To compute and then clear a Time Instant:
TimeTool * Compute "Satellite/ScenTestSat AnalysisStartTime Time Instant"
TimeTool * Clear "Satellite/ScenTestSat AnalysisStartTime Time Instant"
Example
To create, modify and then delete a Filtered Time Array:
TimeTool * Satellite/ScenTestSat Create "Time Array" SatArray4 "Filtered"
TimeTool * Satellite/ScenTestSat Modify "Time Array" SatArray4 "Filtered" Filter SkipTimeStep TimeStep 120.0
TimeTool * Satellite/ScenTestSat Delete "Time Array" SatArray4
Example
To export Satellite time components to a file and then import them to Place1:
TimeTool * Export "C:\Users\stkUser\ExportImport\Export1.awb" "Satellite/Satellite1 1700-1800 Interval" "Satellite/Satellite1 1720-1820 Interval"
TimeTool * Import Place/Place1 "C:\Users\stkUser\ExportImport\Export1.awb"
Example
Rename the specified time component to TestOName and then duplicate it, allowing STK to name the duplicated component:
TimeTool * Rename "Satellite/Satellite2 30Minutes Interval" TestOName
TimeTool * Duplicate "Satellite/Satellite2 TestOName Interval"
Rename the specified Time template:
TimeTool * RenameTemplate "Facility beginTime Time Instant" FirstTime
Example
Add a user description to a Time template:
TimeTool * UserDescription "Facility FirstTime Time Instant" "The starting time, for the beginning; of the first_part of my very special template."
Add a user description to a Time component:
TimeTool * UserDescription "Satellite/Satellite2 30Minutes Interval" "My very special time interval."
ReturnMessage
Group Membership
This command belongs to the following group(s):
Version
11.5