Scenario Scope Functions

bool LoadLeapSecondAndEOPFiles(string LeapSecondFile, string EOPFile)

This loads the specified leap second and EOP files. Use it to update leap second information while ODTK is running. Typically, you should update both leap second and EOP information together because the EOP information reflects the existence of the leap second via a step discontinuity in the UTI-UTC data at the time of the leap second. If leap second information is updated — due to the announcement of a new leap second — prior to the new leap second being reflected in the EOP data, it will introduce a discontinuity in the modeled rotation of the Earth.

The explicit specification of either input file is optional. If you pass an empty string instead of a full file path for the leap second file, the function will load the existing leap second file in the scenario properties. If you pass an empty string instead of a full file path for the EOP file, the function will load the existing EOP file as specified in the scenario properties. If you specify a full file path for either the leap second or EOP file or both, the fuction will load the specified file(s) and update the scenario properties to reflect the new file name(s).

Parameters

Return Value

Example VBS:

1
2
3
leapSecFile = "C:\MyEarthData\NewLeapSecond.dat"
eopFile = "C:\MyEarthData\NewEOP=v1.1.txt"
success = odtk.Scenario(0).LoadLeapSecondAndEOPFiles(leapSecFile, eopFile)

CAgAttr GetLeapSecondTable()

Return Value

The function returns a CAgAttr object that contains the following properties:

Example VBS:

1
Set leapSecTable = odtk.Scenario(0).GetLeapSecondTable()

bool ReloadEOP()

Use this to reload the Earth Orientation Parameters data file.

Return Value

Example VBS:

1
bResult = sc.ReloadEOP

bool ReloadFacilityAssociationsFile()

Use this to reload the Facility Associations File by the FacilityAssociationsFile attribute.

Return Value

Example VBS:

1
bResult = sc.Scenario(0).ReloadFacilityAssociationsFile()

bool ReloadFlux()

This function forces clearing of the flux data cache and subsequent reloading of the flux data.

Return Value

Example VBS:

1
bResult = sc.ReloadFlux

bool ReplaceICRFWithJ2000()

This function looks for references to the ICRF frame and converts them to the J2000 frame. For Satellite and GNSSSatellite orbits, it transforms the orbit from ICRF to J2000. It will also check the ephemeris generation CoordFrame and check each maneuver frame, changing frames from ICRF to J2000. It does not otherwise modify maneuver data. Any changes appear in the Message Viewer.

Return Value

Example VBS:

1
bResult = sc.ReplaceICRFWithJ2000

CAgAttr RINEXClockToSimrun(string inputFile, string outputFile)

This is a helper function to the RinexReceiverClock_to_simrun utility, which creates a .simrun file containing Receiver Clock Data. It extracts clock data from the given RINEX file for each receiver in the scenario. It extracts data for a receiver if the receiver contains (1) the four-character IGS mnemonic as part of its name and (2) a clock phase estimate for each time point in the file. If the clock file does not contain clock phase rate values, frequencies in the .simrun file are set to zero.

Parameters

Return Value

The function returns a CAgAttr object that contains the following properties:

Example VBS:

1
2
3
4
5
ifile = "C:\tmp\igs6445.clk"
ofile = "c:\tmp\igs6445.simrun
set retv = ODTK. RINEXClockToSimrun (ifile, ofile)
odtk.writemessage retv.Succeed,"force"
odtk.writemessage retv.Messages,"force"

bool SetEphCoordFrame(string cbName, string coordFrame)

This updates the Scenario SatEphemeris.CoordFrame list and also resets all output ephemeris coordinate frame settings in the Satellite, Simulator, Filter, VLS, and Smoother objects for satellites having initial conditions referenced to a given central body.

Parameters

Return Value

Example VBS:

1
bResult = sc. SetEphCoordFrame("Earth", "Fixed")

CAgAttr SetInputFluxFileOnAllPropagators(string inputFile)

This function finds all of the writeable Propagator components in the Component Browser and sets the input flux file as the flux and geomagnetic data file on the atmospheric drag propagator, if it exists. If the atmospheric drag propagator function is configured for a constant values source flux, it will automatically be changed to the data file source type. If the function encounters an error setting the file on any propagator, it will stop execution and return the error message. Any remaining propagator functions will not have the input file set.

Parameters

Return Value

The function returns a CAgAttr object that contains the following properties:

Example JavaScript:

1
2
3
4
5
6
let inputFluxFilePath = "C:\\ProgramData\\AGI\\STK_ODTK 13\\DynamicEarthData\\SpaceWeather-All-v1.2.txt";
let result = sc.EarthDefinition.FluxData.SetInputFluxFileOnAllPropagators(inputFluxFilePath);
if(!result.Succeed.value())
{
   alert(result.Messages.value());
}

CAgAttr TimeSpan()

This function gets the scenario start and stop times based on the scenario DefaultTimes.Processes settings.

Return Value

The function returns a CAgAttr object that contains the following members, which are both Date objects:

Example VBS:

1
2
3
set ts = sc.TimeSpan
odtk.writemessage ts.StartTime.Format("UTCG"),"debug"
odtk.writemessage ts.StopTime.Format("UTCG"),"debug"