Description | Example | Return Message | Group

TimeTool Collection of Interval Lists

Define and modify Collection of Interval Lists components and templates.

Syntax

TimeTool <ScenarioPath> <ParentObject> {Action} {"Collection of Interval Lists" | "Collection of Interval ListsTemplate"} <ComponentName> [{CollectionOfIntervalListsType} <TypeParams>]

Related Commands

Description

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

Note: The Collection of Interval Lists Time type is not valid for Scenario, CentralBody, Access, Chain, Planet, or Star objects.

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

{Action} Parameters Description
Create {CollectionOfIntervalListsType} [<TypeParams>] <TypeParams> are optional, except where noted below. If no <TypeParams> are specified, default values are used.
Modify {CollectionOfIntervalListsType} <TypeParams> The values <ComponentName> {CollectionOfIntervalListsType} must define an existing Collection of Interval Lists component or template. The {CollectionOfIntervalListsType} 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 {CollectionOfIntervalListsType} can be specified on a command line, except where indicated.

The following table describes each Collection of Interval Lists type and it's parameters.

{CollectionOfIntervalListsType} <TypeParams>
"Field-of-View Obscuration"
  • UseParentBodies {Yes | No}
  • IncludeSun {Yes | No}
  • EclipsingBody <CBName>

EclipsingBody "<CBName>" can be entered multiple times in one command and will replace the current EclipsingBody list.

Advanced options:

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

Note: The <ParentObject> for the "Field-of-View Obscuration" type must be a Sensor.
"Lighting"
  • Location "<Point>"
  • UseParentBodies {Yes | No}
  • EclipsingBody <CBName>

EclipsingBody "<CBName>" can be entered multiple times in one command and will replace the current EclipsingBody list.
"Satisfaction"
  • ConditionSet "<Condition>"

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

SignalSpeed parameter is valid if SignalType is Custom.

<Delay> is entered in Connect time units.

ReferenceSystem parameter is valid if SystemType is Custom.

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

Example

To create and modify a Lighting Collection of Interval Lists:

TimeTool * Satellite/ScenTestSat Create "Collection of Interval Lists" SatCollection3 "Lighting"

TimeTool * Satellite/ScenTestSat Modify "Collection of Interval Lists" SatCollection3 "Lighting" UseParentBodies No EclipsingBody Mars EclipsingBody Venus EclipsingBody Mercury

To create and modify a Satisfaction Collection of Interval Lists:

TimeTool * Satellite/ScenTestSat Create "Collection of Interval Lists" SatColl31 "Satisfaction" ConditionSet "Satellite/ScenTestSat SatCalc21 Condition Set"

TimeTool * Satellite/ScenTestSat Modify "Collection of Interval Lists" SatColl31 "Satisfaction" ConvergeAbsoluteTolerance 1113.45 ConvergeRelativeTolerance 0.67

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Area Targets

Comm

Facilities, Places & Targets

Line Targets

Radar

Sensors

Object Tools

Vehicles

Volumetric

VO

VO Objects

Version

10.1

STK Programming Interface 11.0.1