Description | Example | Return Message | Group

DeckAccess

Calculate deck access

Syntax

DeckAccess <FromObjectPath> {{TimeInterval} | UseObjInterval} {TargetDeckType} "<TargetDeck>" {SortObj | SortTime} {OutReport | OutFile "<OutputFilePath>"} [{OptionalParameters}]

Description

The DeckAccess command allows you to set the values for and calculate access from one object to all objects in a specified class. For instance, you could use this command to calculate access from a single ground station to all satellites in the scenario.

The following table describes the inputs to the DeckAccess command. All inputs must be entered.

Input Description
{{TimeInterval} | UseObjInterval} Use {TimeInterval} to define the beginning and end of the access period. For valid {TimeInterval} values see Time Options.

If the <FromObjectPath> is a vehicle then the times must be within the vehicle's time period, or the command will Nack.

Specify UseObjInterval to use the object's start and stop times.

{TargetDeckType} "<TargetDeck>" {TargetDeckType} defines the type of target deck and "<TargetDeck>" contains the list of objects, of the specified type, to which access will be calculated.

The following list shows the valid values for {TargetDeckType} and the valid "<TargetDeck>" for each:

  • AreaTarget "<FileName.shp>"
  • Facility "<FileName.lla>"
  • Satellite "<FileName.tce>"
  • Star "<FileName.str>"
  • StarCollection "<Star Collection Name>"
{SortObj | SortTime} SortObj indicates that output is to be sorted by object name; SortTime indicates that output is to be sorted by start time.
{OutReport | OutFile "<OutputFilePath>"} Specify OutReport to have access data returned over the Connect socket. Specify OutFile, along with the required "<OutputFilePath>" to indicate that access data is to be written to the specified "<OutputFilePath>".

The <ConstraintObjectPath> option available for this command in previous versions has been deprecated in STK 10. This option will be maintained for backward compatibility only. To set the Constraint Object use the ConstraintObject option described below in {OptionalParameters}.

The following table describes {OptionalParameters}.

Option Description
ConstraintObject <TruncObjectPath> The ConstraintObject is used to apply specific constraints to the access. To use this option, define an object with the constraints of interest, then specify that object as the <TruncObjectPath>. All constraints applied to that object will be applied across the access objects.
TLEEpochFilter {Off | <Value>} If this option is entered with <Value>, then it will exclude any TLE whose epoch date precedes the beginning, or follows the end, of the analysis period by the amount of time specified in <Value>.

<Value> is entered in Connect Time units, and must be between 1 day (86400 seconds) and 10 years. The default value is Off.

This option is only available if TargetDeck is Satellite.

AddSatellites <MaximumNumber> Indicate the maximum number of satellites to add to the Scenario.

<MaximumNumber> is an integer between 0 and 100000. The default value is 0.

This option is only available if TargetDeck is Satellite.

SetModelScale {Off | <ScaleValue>} Specify the model scale for Satellites added to the Scenario. Use the AddSatellites option to indicate whether Satellites are added to the Scenario.

<ScaleValue> is a real number between 0.0 and 10.0. The default value is Off, meaning the model scale will not be changed.

This option is only available if TargetDeck is Satellite.

AltitudeDefinition {AboveEllipsoid | OnTerrain} Specify how altitude information from the selected input file will be used/interpreted. A selection of AboveEllipsoid will result in altitude values from the file being interpreted as geodetic altitude above the reference shape of the scenario central body (WGS-84 ellipsoid for the Earth). If altitude is not specified in the file, it is set to zero. A selection of OnTerrain will result in the altitude values from the file being overwritten with the terrain altitude at each specified geodetic location.

This option is only available if TargetDeck is Facility, Place or Target.

Example

To calculate access from the ERS1 satellite to all area targets defined in a scenario from 1 Jul 2000 at midnight to 2 July 2000 at midnight:

DeckAccess */Satellite/ERS1 "1 Jul 2000 00:00:00.00" "2 Jul 2000 00:00:00.00" AreaTarget "c:/ProgramData/STKData/GroundFacilities.shp" SortTime OutReport

To calculate access from the satellite, over the satellite's time period, and write the report to a file:

DeckAccess */Satellite/Satellite1 UseObjInterval Satellite "C:\Users\Documents\STK 9\stkActiveTLE.tce" SortObj OutFile "C:\MyTemp\DATestSat1.rpt"

To calculate access from the satellite to the star collection, over the satellite's time period, and write the report to a file:

DeckAccess */Satellite/Satellite2 UseObjInterval StarCollection "Hipparcos 2 Mag 6" SortObj OutFile "C:\MyTemp\DATestSat2.rpt"

To calculate access from the satellite, add the first twelve satellites that have access to the Scenario and set the Model Scale of those Satellites to 2.5:

DeckAccess */Satellite/Satellite1 "1 Jul 2009 16:00:00.00" "1 Jul 2009 17:00:00.00" Satellite "C:\ProgramData\AGI\STK 9\Databases\Satellite\TLE350.tce" SortObj OutReport AddSatellites 12 SatModelScale 2.5

ReturnMessage

If OutReport is entered, Connect returns access data.

Group Membership

This command belongs to the following group(s):

Object Tools

Version

10

STK Programming Interface 11.0.1