Description | Example | Return Message | Group

TimeTool Time Instant

Define and modify Time Instant components and templates.

Syntax

TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Instant" | "Time InstantTemplate"} <ComponentName> [{TimeInstantType} <TypeParams>]

Related Commands

Description

The "TimeTool Time Instant" command is used to add, modify and delete Time Instant components and templates.

For a component object the <ParentObject> is a truncated object path.

For a template the <ParentObject> is an STK class name, and the "Time InstantTemplate" keyword must be entered.

The following table provides a description of {Action} values and the applicable parameters:

{Action} Parameters Description
Create {TimeInstantType} [<TypeParams>] <TypeParams> are optional, except where noted below. If no <TypeParams> are specified, default values are used.
Modify {TimeInstantType} <TypeParams> The values <Time InstantName> {TimeInstantType} must define an existing Time Instant component or template. The {TimeInstantType} can not be modified. <TypeParams> are required.
Delete N/A Delete the component or template identified by <ComponentName>

Any or all of the <TypeParams> for a {TimeInstantType} can be specified on a command line, except where indicated.

The following table describes each Time Instant type and it's parameters.

{TimeInstantType} <TypeParams>
"Fixed Epoch"
  • Epoch "<DateTime>"

Enter the "<DateTime>" in Connect date units.
"Fixed Time Offset"

Any or all of the following keyword-value pairs can be specified:

  • ReferenceTimeInstant "<TimeInstant>"
  • TimeOffset <Value>

<Value> is entered in Connect time units.
"Signaled"

Any or all of the following keyword-value pairs can be specified:

  • Original "<TimeInstant>"
  • BaseClockLocation "<Point>"
  • TargetClockLocation "<Point>"
  • SignalSense {Transmit | Receive}
  • SignalTransmissionType {Light | Custom}
  • SpeedValue <Speed>
  • TimeDelayConvergence <Delay>
  • SignalPathRefSystem {UseAccessDefault | SSBarycenter | CBInertial | Custom}
  • CustomSystem "<RefSystem>"

<Speed> is entered in Connect Time units / seconds.

The SpeedValue parameter is valid if SignalTransmissionType is Custom.

<Delay> is entered in Connect time units.

The CustomSystem parameter is valid if SignalPathRefSystem is Custom.

Note: The Signaled Time Instant is not valid for Scenario or Chain objects.
"Start-Stop Time"

Any or all of the following keyword-value pairs can be specified:

  • ReferenceInterval "<Interval>"
  • EdgeType {Start | Stop}
"Time of Extremum"

Any or all of the following keyword-value pairs can be specified:

  • Calculation "<CalcScalar>"
  • ExtremumType {Minimum | Maximum}

Advanced options:

  • SaveOption {UseApplicationPrefs | SaveComputedData | None}
  • SetTimeLimits {UseApplicationPrefs | Local}
  • TimeLimits "<IntervalOrIntervalList>"

If SetTimeLimits is set to Local then the time interval or interval list specified by the TimeLimits parameter will be used. The "<IntervalOrIntervalList>" should include the time component type, e.g. "Satellite/Sat1 EphemerisTimeSpan Interval"

  • SamplingType {FixedStep | RelativeTolerance | CurvatureTolerance}

Parameters for SamplingType FixedStep:

  • TimeStep <TimeStep>

Parameters for SamplingType RelativeTolerance:

  • MinimumTimeStep <MinStep>
  • MaximumTimeStep <MaxStep>
  • StepAtBoundaries <StepBound>
  • SamplingRelativeTolerance <RelTol>
  • SamplingAbsoluteTolerance <AbsTol>

Parameters for SamplingType CurvatureTolerance:

  • MinimumTimeStep <MinStep>
  • MaximumTimeStep <MaxStep>
  • StepAtBoundaries <StepBound>
  • SamplingRelativeTolerance <RelTol>
  • SamplingAbsoluteTolerance <AbsTol>
  • CurvatureTolerance <CurveTol>

<TimeStep>, <StepBound>, <MinStep> and <MaxStep> are entered in Connect time units and must be between 1e-13 and 99999999999.0.

<RelTol>, and <CurveTol> must be between 1e-13 and 1.0

<AbsTol> must be greater or equal to 1e-13

Parameters for Convergence:

  • TimeTolerance <TimeTol>

<TimeTol> is entered in Connect time units, and must be between 1e-13 and 99999999999.0.

Note: The Time of Extremum Time Instant is not valid for Scenario or Chain objects.

For details on the format of a reference component (e.g. "<CalcScalar>", "<Interval>", "<RefSystem>", etc) see Component Specification.

Example

To create and modify a Fixed Epoch Time Instant:

TimeTool * Satellite/ScenTestSat Create "Time Instant" SatEvent1 "Fixed Epoch"

TimeTool * Satellite/ScenTestSat Modify "Time Instant" SatEvent1 "Fixed Epoch" Epoch "1 Oct 2011 04:45:00.00"

To create and modify a Signaled time instant for Exton:

TimeTool * Place/Exton Create "Time Instant" ExtonEvent5 "Signaled"

TimeTool * Place/Exton Modify "Time Instant" ExtonEvent5 "Signaled" SignalTransmissionType Light TimeDelayConvergence 1267.89 SignalPathRefSystem CBInertial SignalSense Receive BaseClockLocation "Satellite/ScenTestSat Body.Origin Point"

ReturnMessage

If activated, Connect returns an acknowledgement message.

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

STK Programming Interface 11.0.1