Description | Example | Return message | Group

TimeTool Interval

Define and modify Interval components and templates.

Syntax

TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval" | "IntervalTemplate"} <ComponentName> [{IntervalType} <TypeParams>]

Related commands

Description

The "TimeTool Interval" command is used to add, modify and delete Interval 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 "IntervalTemplate" keyword must be entered.

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

{Action}ParametersDescription
Create{IntervalType} [<TypeParams>]<TypeParams> are optional, except where noted below. If no <TypeParams> are specified, default values are used.
Modify{IntervalType} <TypeParams>The values <ComponentName> {IntervalType} must define an existing Interval component or template. The {IntervalType} can not be modified. <TypeParams> are required.
DeleteN/ADelete the component or template identified by <ComponentName>

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

The following table describes each Interval type and its parameters.

{IntervalType}<TypeParams>
"Between Time Instants"
  • StartTimeInstant "<TimeInstant>"
  • StopTimeInstant "<TimeInstant>"
"Fixed Duration"
  • ReferenceTimeInstant "<TimeInstant>"
  • StartOffset <Value>
  • StopOffset <Value>

<Value> is entered in Connect time units.

"Fixed Interval"
  • StartTime "<DateTime>"
  • StopTime "<DateTime>"

Enter the "<DateTime>" in Connect date units.

"Fixed Time Offset"
  • ReferenceInterval "<Interval>"
  • TimeOffset <Value>

<Value> is entered in Connect time units.

"Interval From List"
  • IntervalList "<IntervalList>"
  • Selection {Span | NumberForward | NumberBackward | MinimumDuration | MaximumDuration | MinimumGap | MaximumGap}
  • Number <Value>

The Number <Value> parameter is valid only if Selection is NumberForward or NumberBackward. <Value> is an integer greater or equal to 1.

"Offset from Time Instant"
  • ReferenceTimeInstant "<TimeInstant>"
  • OffsetBefore <Value>
  • OffsetAfter <Value>

<Value> is entered in Connect time units. OffsetBefore value is subtracted from the time and OffsetAfter value is added to the time to create the interval.

"Scaled"
  • OriginalInterval "<Interval>"
  • AbsoluteIncrement <Value>
  • RelativeIncrement <Value>

AbsoluteIncrement <Value> is entered in Connect time units. RelativeIncrement <Value> is a real number greater or equal to -100.0. AbsoluteIncrement and RelativeIncrement can not both be entered in the same command.

"Signaled"
  • 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.

The Signaled Interval is not valid for Chain, CoverageDefinition, or Scenario objects.

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

When specifying a reference component or template in the Create or Modify commands the {ComponentType} is implied based on the {IntervalType} being created or modified and the {ComponentType} need not be entered. In the second example below, "Satellite/ScenTestSat SunGlint Point" is entered as "Satellite/ScenTestSat SunGlint", since the command is expecting a Point.

Examples

To create and modify a Fixed Interval:

TimeTool * Satellite/ScenTestSat Create "Interval" SatInterval1 "Fixed Interval"
TimeTool * Satellite/ScenTestSat Modify "Interval" SatInterval1 "Fixed Interval" StartTime "1 Oct 2011 04:45:00.00" StopTime "1 Oct 2011 05:25:00.00"

To create and modify a Signaled time interval for Exton:

TimeTool * Place/Exton Create "Interval" ExtonInterval5 "Signaled"
TimeTool * Place/Exton Modify "Interval" ExtonInterval5 "Signaled" SignalTransmissionType Light TimeDelayConvergence 1267.89 SignalPathRefSystem CBInertial SignalSense Receive BaseClockLocation "Satellite/ScenTestSat Body.Origin"

Return 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

11.3