Application Scope Functions

You should load a scenario prior to running these functions from a script. This allows the Ansys Orbit Determination Tool Kit (ODTK®) application to explicitly set attributes affecting coordinate transformations (EOP, nutation), as opposed to using internal defaults when no scenario exists. Some functions will only run when a scenario is loaded, while other functions do not make that check themselves.

The attribute names are not case sensitive, but their parameters are case sensitive. For example, you can use "extractstatehistory" for the attribute ExtractStateHistory, but you must spell the parameter "/coordSys" exactly as specified in the table, with lowercase "c" and the first "S" capitalized.

CAgAttr AccountID()

Use this to see the account ID string, such as 26884.

Return Value

CAgAttrString

String object containing the account ID

Example VBS:

Copy 
accountIDStr = ODTK.AccountID

CAgAttr AppVersion()

Use this to see the ODTK application version number, such as "7.2.0".

Return Value

CAgAttrString

String object containing the application version

Example VBS:

Copy 
version = ODTK.AppVersion

bool CheckForCrossCorr(string runFile)

This is a help function for the StateDiff html utility. It determines if a run file contains cross-correlations.

Parameters

runFile string

The path to a run file

Return Value

bool

True if the file contains cross-correlations

Example VBS:

Copy 
runFile = "C:\tmp\Scenario1.filrun"
ODTK.writemessage ODTK.CheckForCrossCorr(runFile), "force"

bool CombineFilters(string outputCombinedFile, string outputDifferencedFile, string referenceFile, string targetFile, bool bLastMeasOnly, string startTime, string StopTime, bool bSaveCrossCorrelations)

This function compares and combines two independent filter estimates, usually a "backward" Filter run with a "forward" Filter run.

The outputCombinedFile is the resultant combined Filter file (.filrun), and other parameters are the same as for the "CreateDifference" function.

 

CAgAttr ConcatenateSP3Files(string sInFile1, string sInFile2, string sOutFile)

This concatenates two SP3 files together. It requires that the second file begin exactly one interval after the first file ends. If a PRN is not in both files, the function will expand the header to include it and set the "P" and "V" records to zeros over the file time span where it is not present. This function does not perform coordinate transformations, so whether you loaded a scenario or not is irrelevant.

Parameters

sInFile1 string

The first input filename
sInFile2 string The second input filename
sOutFile string The output filename

Return Value

The function returns a CAgAttr object containing the following members:

Succeed A Boolean indicating success or not
Messages

A status message string

Example VBS:

Copy 
set retVal = ODTK.ConcatenateSP3Files(inputFile1,inputFile2,outputfile)
ODTK.WriteMessage retVal.Messages, "debug"
ODTK.WriteMessage "Success? " & retVal.Succeed, "debug"

bool CopyObject(CAgAttr object)

Use this to copy an object to the clipboard for use in later paste operations, such as IsPasteAvailable and PasteObject functions.

Parameters

object CAgAttr

The object to copy

Return Value

The function returns a CAgAttr object containing the following members:

Succeed

A Boolean indicating success or not

Example VBS:

Copy 
bSuccess = ODTK.CopyObject(sc.Satellite(0))

bool CreateDifference(string outputFile, string referenceFile, string targetFile, bool bLastMeasOnly, string startTime, string stopTime, bool bSaveCrossCorrelations)

This function is called by the StateDiffTool to difference states from two different processes and produces a .difrun file for reporting and graphing. The differences are defined as target - reference, where orbits are differenced in an RIC frame.

Parameters

outputFile string

Enter the path to the resultant difference file (.difrun).
referenceFile string Enter the path to an input filename (.filrun, etc).
targetFile string Enter the path to the other input filename (.filrun, etc).
bLastMeasOnly bool A value of True limits output to one point per measurement time, as opposed to multiple differences at duplicate measurement times.
startTime string Enter a date/time string in UTCG. An empty string tells the function to use the file start time.
stopTime string Enter a date/time string in UTCG. An empty string tells the function to use the file stop time.
bSaveCrossCorrelations bool A value of True causes the writing of the entire covariance matrix to the output file. A value of False reduces the size of the output file.

If the start and stop times are empty strings, the function will use the entire file span.

Return Value

bool

A Boolean indicating success or not

Example VBS:

Copy 
ref = "c:\tmp\Scenario1.filrun"
tgt = "c:\tmp\Scenario1.simrun"
output = "c:\tmp\Scenario1.difrun"
t1 = "11 Jul 2010 00:30:00"
t2 = "11 Jul 2010 01:25:00"
set retv = ODTK.CreateDifference(output, ref, tgt, true, t1, t2, false)

CAgAttr CreateNavSolFile(string ephemFile, string outputFile, string options)

This function creates a GNSS Navigational Solution file from an ephemeris (*.e) file.

Parameters

ephemFile string

The path to the satellite ephemeris file
outputFile string The path to file that will contain the NavSol data
options string

An optional string containing a receiver ID and the time precision specification:

  • /recID = GNSS Receiver ID (default = 800)

  • /prec = time precision (default = 0.001 sec)

Return Value

The function returns a CAgAttr object containing the following members:

StartTime

A string showing the start time of the file
StopTime A string showing the stop time of the file
Succeed A Boolean indicating success or not

Example VBS:

Copy 
eFile = "C:\tmp\MySat.e"
nFile = "C:\tmp\MySat.navsol"
options = "/recID 133"
set result = odtk.createNavSolFile(eFile, nFile, options)
odtk.writemessage result.Succeed, "force"
odtk.writemessage result.startTime, "force"
odtk.writemessage result.stopTime, "force"

CAgAttr CreateObj(CAgAttr parent, string className, string objectName)

This function creates an object as a child of a specified object.

Parameters

parent string

The parent object
className string The type of object to add
objectName string The name of the new object

Return Value

CAgAttr

A handle to the newly created object

Example VBS:

Copy 
Set scenObj = ODTK.CreateObj(ODTK, "Scenario", "Scen1")
Set satObj1 = ODTK.CreateObj(scenObj, "Satellite", "Sat1")

CAgAttr CreateRestartFDRecord(string restartMetaFile, string time, string satName, string recordName)

This function adds a new Flight Dynamics Record component to the Component Browser from a restart record.

Parameters

restartMetaFile string

The file under the Restart directory of the form <object>_<scenarioName>.bin
time string A string representing the time of the restart record you are interested in
satName string

The name of the satellite object you're interested in
recordName string The name of the new Flight Dynamics Record to be added to the Component Browser

Return Value

The function returns a CAgAttr object containing the following members:

Succeed A Boolean indicating success or not

Example JavaScript:

Copy 
const simulator = ODTK.Application.GetRestartPath(sc.Name.value(), "Simulator1");
const restartMetaFile = simulator.RestartPath.value();
const fdResult = ODTK.Application.CreateRestartFDRecord(restartMetaFile,
                                                       "1 Jul 2024 13:00:00.000", 
                                                       "Satellite1", 
                                                       "NewRecord");
const succeess = fdResult.Succeed.value();

CAgAttr CreateRunFileFDRecord(string runFileName, string timeMode, string desiredTimeStr, string satName, string recordName)

Use this to add a new Flight Dynamics Record to the Component Browser from a run file.

Parameters

runFileName string

The path to a .filrun, .simrun, or .smtrun file
timeMode string First, Last, Closest, ClosestBefore, or ClosestAfter; determines how the function chooses a time from the run file
desiredTimeStr string

A string representing the time of the desired state
satName string The name the satellite to create the state configuration component from
recordName string A string representing the name you want to give to the new flight dynamics record component

Return Value

A CAgAttr object containing the following members

Succeed A Boolean indicating success or not

Example JavaScript:

Copy 
const simulator = sc.Simulator(0);
const runFile = simulator.Output.DataArchive.Filename.value();
const fdResult = ODTK.Application.CreateRunFileFDRecord(runFile,
                                                        "Closest",
                                                        "1 Jul 2024 14:30:00.000",
                                                        "Satellite1",
                                                        "NewRecord")
const success = fdResult.Succeed.value();

bool CreateUpdatedAccelerationHistoryFile(string runFilename, string accelerationHistoryFilename, string updatedAccelerationHistoryFilename, string satelliteName, string maneuverName)

Use this to create a new acceleration history file by updating an existing one using deltas simulated or estimated by ODTK processing.

Parameters

runFilename string

The path to the run file from which to extract data
accelerationHistoryFilename string The path to the original file defining the maneuver
updatedAccelerationHistoryFilename string

The path to the file being created
satelliteName string The name of the satellite executing the maneuver
maneuverName string The name of the maneuver

Return Value

bool A Boolean indicating success or not

Example Python:

Copy 
ODTK.CreateUpdatedAccelerationHistoryFile("C:\tmp\Scenario1.filrun",
                                          "C:\tmp\sampleAccelHistory.accelhist",
                                          "C:\tmp\updatedAccelHistory.accelhist",
                                          "Satellite1",
                                          "NewFiniteManAccelFile0")

bool CutObject(CAgAttr object)

This copies an object to the clipboard for use in further paste operations while also deleting the object from the scenario. See also the function PasteObject.

Parameters

object CAgAttr

An ODTK object

Return Value

bool

True if the object was cut

Example VBS:

Copy 
bSuccess = ODTK.CutObject(sc.Sat1.ToGround)

bool DeleteObject(CAgAttr object)

This takes an ODTK object as the input and returns a Boolean indicating success or not.

Parameters

object CAgAttr

An ODTK object

Return Value

bool

True if the object was deleted

Example VBS:

Copy 
bSuccess = ODTK.DeleteObject(sc.Satellite1)

bool DumpFile(string inputSP3, string outputTxt)

This function is called by FileDumperTool to list (i.e., print) contents of a GNSS SP3 ephemeris file to a text file.

Parameters

inputSP3 string

The SP3 file filename
outputTxt string The desired output filename

Return Value

bool Always true

Example VBS:

Copy 
input = "c:\tmp\input.sp3"
output = "c:\tmp\sp3dump.txt"
bSuccess = ODTK.dumpFile(input, output)

CAgAttr ExportObj(CAgAttr object, string filename, bool bSaveChildren)

Use this to save an object by specifying the actual object and a flag indicating whether or not to save children of the object.

When applied to scenarios, ExportObj will save the scenario and any restart records to a new location but will keep all internal paths pointing to the old location.

Parameters

object CAgAttr

The object to be saved
filename string The path to the output file to be saved
bSaveChildren bool A Boolean specifying whether or not to save the child objects as well

Return Value

CAgAttr The exported object

Example VBS:

Copy 
ODTK.ExportObj(scen, "C:\tmp\Scenario1copy1.sco", true)

CAgAttr ExportObservationIntervals(string outputFile, string satName, string trkName, double gap, double pad, string options)

Use this to create interval files based on the scenario's loaded observation measurement files. It is a helper function for the SaveObservationIntervals tool. The simulator can then import or link to these interval files for use in the custom tracking schedule. If you enter both the satName and trkName as empty strings, the resulting interval file will identify both objects from within the file. This may not work for three-, four-, or five-legged measurements.

Parameters

outputFile string

Provide the path to the desired interval filename (*.int).
satName string Providing this will cause the function to only write those intervals relating to the satellite you specify, and as a result, the satellite names will not show up in the interval file. An empty string will cause intervals for any satellite to show up, and the associated satellite name will be appended as additional data for each interval.
trkName string Providing this causes the same behavior as satName except regarding facilities.
gap double (seconds) Enter the minimum gap that defines a pass of data, which defines when one interval starts and the next ends. If this value is less than the measurement granularity, there will be one interval written per measurement, so make sure this value is large enough to be realistic. For instance, if you have measurements every minute and then a data gap of 40 minutes before the next set of measurements, setting gap to be anywhere from 2-30 minutes will be sufficient.
pad double (seconds) Specifying this enables you to expand the interval start and stop times.
options string This is a string which is not used.

Return Value

The function returns a CAgAttr object containing the following members:

Succeed A Boolean indicating success or not

Example VBS:

Copy 
outFile = "C:\tmp\Meas.int"
sat = ""
trk = ""
gap = 1200.0
pad = 0.0
options = ""
set result = ODTK.ExportObservationIntervals(outFile, sat, trk, gap, pad, options)
odtk.WriteMessage result.Succeed, "debug"

bool ExtractEphemeris(string referenceFile, string primarySat, string outputFile, bool inclCov, string covType, string coordFrame, string sOptions)

This is a helper function called by the CreateEphFileTool HTML page. It extracts satellite ephemeris from a run file to an ephemeris (*.e) file.

Parameters

referenceFile string

Enter the path to the run file to extract ephemeris from.
primarySat string Enter the name of the satellite or surface vehicle object in the file.
outputFile string Enter the path to the desired output ephemeris file name.
inclCov bool This controls whether or not covariance is output.
pad string

This controls whether or not the function saves the velocity covariance; the choices are:

  • "Position 3x3 Covariance"

  • "Position Velocity 6x6 Covariance"
coordFrame string Use this to specify the output coordinate frame: "ICRF", "Fixed", etc. Choices depend on the central body. See Satellite.EphemerisGeneration.CoordFrame. If the selected output coordinate frame is not the run file default central body frame, then you must load a scenario object to define the central body orientation parameters necessary for the coordinate frame transformation.
sOptions string

(Optional) Provide a string containing one or more additional parameters consisting of a keyword followed by a value string:

  • includeCorr says whether to include correlations in the relative covariance, (e.g., /includeCorr "TRUE").

  • targetName is the name of another satellite, surface vehicle, or central body (e.g., /targetName "Sat2") that causes the covariance to be calculated as relative to this satellite, surface vehicle, or central body.

  • startTime is the start time in UTCG units, (e.g., /startTime "01 Jul 2012 00:00:00"). If not provided, the function will use the file start time.

  • stopTime is the stop time in UTCG units, (e.g., /stopTime "02 Jul 2012 00:00:00"). If not provided, the function will use the file stop time.

Return Value

bool A Boolean indicating success or not

Example VBS:

This is an example of extracting filter ephemeris and output position/velocity and Position 3x3 covariance in the Fixed frame.

Copy 
refFile = "C:\tmp\Scenario1.filrun"
sat = "Satellite3"
eFile = "c:\tmp\sat3.e"
covType = "Position 3x3 Covariance"
coordFrame = "Fixed"
bRes = odtk.ExtractEphemeris(refFile, sat, eFile, true, covType, coordFrame, "")
odtk.WriteMessage bRes, "debug"

Example VBS:

This is an example of generating relative covariance.

Copy 
refFile = "C:\tmp\Scenario1.filrun"
sat = "Satellite3"
eFile = "c:\tmp\sat3.e"
covType = "Position 3x3 Covariance"
coordFrame = "ICRF"
sInclCorr   = "/inclCorr ""TRUE"""
sTargetName = "/targetName ""Satellite1"""
sOptions    = sInclCorr & sTargetName
bRes = odtk.ExtractEphemeris(refFile, sat, eFile, true, covType, coordFrame, sOptions)
odtk.WriteMessage bRes, "debug"

bool ExtractGlobalDensityCorrections(string referenceFile, string outputFile, bool inclCov, string startTime, string stopTime)

This function extracts global atmospheric density corrections from a run file and puts them in an ASCII file (*.gdc) formatted to be compatible with input of the contained corrections for use in the filter estimation process.

Parameters

referenceFile string

Specify the path to the run file to extract global atmospheric density corrections from.
outputFile string Specify the path to the desired output filename (*.gdc).
inclCov bool This controls whether or not covariance is included in the output.
startTime string Specify the start time in UTCG units, (e.g., /startTime "01 Jul 2012 00:00:00"). If you pass an empty string, the function defaults to using the file start time.
stopTime string Specify the stop time in UTCG units, (e.g., /stopTime "02 Jul 2012 00:00:00"). If you pass an empty string, the function defaults to using the file stop time.

Return Value

bool A Boolean indicating success or not

Example VBS:

Extracts global atmospheric density corrections without covariance information from a smoother output for the full time span

Copy 
refFile = "C:\tmp\Scenario1.smtrun"
outputFile = "c:\tmp\DensityCorr.gdc"
odtk.ExtractGlobalDensityCorrections(refFile, outputFile, false, "", "")

CAgAttr ExtractStateHistory(string inputs)

Use this to dump the contents of a binary state history file — accessed as a .filrun, .simrun, .lsrun, or .smtrun file — to a readable text file. This function is typically called by the StateFileDumperTool html utility.

The inputs string is a list of arguments that contains options of the function. You specify the options by including a keyword followed by text in quotes. For example, using backtick strings in JavaScript:

  • let inputs = `/filename "filename" /optionalParam1 "value1" /optionalParam2 "value2"`

. /filename is the only required argument. All other parameters are optional.

Note:

  • If you do not specify an output file, the function will create one using a .txt extension in the same directory as the input file.

  • If you do not specify a start or stop time, the function will dump the entire file contents.

  • If you specify a start time without the stop time, the function will only dump data at that single time.

Parameters

inputs string

Provide a list of arguments that contains options of the function. See the table below for which parameters you can include in the inputs string.

Inputs options

/filename

Specify the path to the desired output file name, e.g., /output "c:\myFile.txt".
/startTime

Specify the start UTC time string, e.g., /startTime "03 Jan 2009 00:12:11.5".
/stopTime

Specify the stop UTC time string, e.g., /stopTime "03 Jan 2009 11:15:21.00".
/step

Specify the step size between outputs in seconds, e.g., /step "120".
/coordType

Select the types of coordinates to report: "Equinoctial", "Cartesian", "Keplerian", or "Spherical".
/coordSys

Provide the coordinate system used to report orbital elements: "ICRF", "J2000", "Fixed", "Inertial", "TrueOfDate", "MeanOfDate", "TEMEOfDate", or for multiple central bodies within one file, this has the form CBname:CoordSys; as in "Earth:J2000;Moon:Inertial;Sun:ICRF".
/covType

Specify which form the output covariance will take: "Cartesian," "Gaussian," or "Frenet".
/covMethod

Specify whether the output covariance is rotated or projected,using the string "Rotated" or "Projected".
/covOutput

Specify whether the output covariance is a full covariance or a sigma-correlation matrix, using "Cov", "SigCor", or "Both".
/covReporting

Specify the format of the output covariance structure: "UpperTriangular", "LowerTriangular", or "FullMatrix".
/data

Specify which type of data to place in the output file, using the following bullets as guidance:

  • This is a four-digit value determining which data is included. For each digit, a value of 1 means "included," and a value of 0 means "not included.":

    • The first (leftmost) digit determines if Satellite Orbits are included.

    • The second digit determines if Satellite Force Model parameters are included.

    • The third digit determines if Measurement Biases are included.

    • The fourth digit determines if Station Locations are included.

  • As an example, if you want Satellite Orbits and Force Model Parameters in the report, and only those values, set /data "1100".

  • If you specify neither /data nor flexData, the function returns all data by default.

  • If you provide the flexData parameter, the function ignores the /data parameter.
flexData

Use this to define a list of states and covariances to place in the output file.

  • flexData must be a comma-separated list of states, followed by a semicolon, and then a comma-separated list of covariances. If there are no covariances, you must still include the break.

  • An example is flexData "Satellite1.Orbit,Satellite2.Orbit;Satellite1.Orbit,Tracker1.TimeBias".

  • You can determine a list of possible states, and whether covariance data exists, by calling GetStateHistoryFileContents using the run file under consideration.

Return Value

The function returns a CAgAttr object containing the following members:

Succeed CAgAttrBool A Boolean indicating success or not
OutputFile CAgAttrString A string showing the output filename
Messages CAgAttrString A string showing errors or other status

Example VBS:

Copy 
input = "/filename ""C:\tmp\Scenario1.filrun"" " &
        "/output ""c:\tmp\filrun.txt"" " & 
        "/startTime ""11 Jul 2010 00:00:00.000"" " &
        "/coordSys ""Fixed"""
set retv = ODTK.ExtractStateHistory(input)
odtk.writemessage retv.Succeed,"force"
odtk.writemessage retv.OutputFile,"force"
odtk.writemessage retv.Messages,"force"

bool GenerateDeltaRADec(string outputMeasFile, double timeTolerance, bool modelTimeTagDifferences)

Use this to generate a file containing relative optical measurements from the list of tracking data files assigned in the scenario Measurements.Files list. The function constructs relative optical measurements when optical measurements to multiple satellites exist at the same time, or within a time tolerance, from the same optical sensor. The function writes all measurements which it cannot difference, including all nonoptical measurements and optical measurements without matching pairings, to the output tracking data file along with the delta-optical measurements.

Parameters

outputMeasFile string

Enter the path of the output file (type: gobs).
timeTolerance double Specify the allowed time difference, in seconds, between time tags for observations to be considered simultaneous.
modelTimeTagDifferences bool This controls whether or not the function models the time tag differences during measurement processing.

Return Value

bool A Boolean indicating success or not

Example VBS:

Copy 
outputFile = "C:\od_6.0\TrackingData\DeltaOptical.gobs"
timeTol = 0.01
ODTK.GenerateDeltaRADec outputFile, timeTol, true

bool GenerateDOWD(string outputDOWDFile, double timeTolerance)

Use this to generate a file of Differenced One-Way Doppler (DOWD) or DSN Interferometric Narrowband Spacecraft (INS) measurements from the tracking data files currently assigned in the Scenario.Measurements.Files list. The specified output file should be of the *.gobs format. The function reflects all input measurements in the output file.

The function constructs DOWD measurements by differencing two simultaneous one-way TDRS Doppler (3L Doppler) measurements. It simply copies all other measurements and single 3L Doppler measurements to the output file.

The function constructs DSN INS measurements by differencing two simultaneous one-way DSN Doppler (DSN 1W Doppler) or TCP (DSN 1W TCP) measurements. It simply copies all other measurements and single DSN 1W Doppler and DSN 1W TCP measurements to the output file.

The generated output file can replace all of the input files for subsequent processing. The method also takes a time tolerance, specified in seconds, as input, which allows for the differencing of measurements with slightly offset time tags.

Parameters

outputDOWDFile string

Enter the path of the output file (type: gobs).
timeTolerance double Specify the allowed time difference, in seconds, between time tags for observations to be considered simultaneous.

Return Value

bool A Boolean indicating success or not

Example VBS:

Copy 
timeTolerance = 0.0
dowdFile = "C:\tmp\MySatDOWD.gobs"
bSuccess = ODTK.GenerateDOWD(dowdFile, timeTolerance)

bool GenerateDOWDFromFiles(string File1, string File2, string outputDOWDFile, double timeTolerance)

bool GenerateDOWDFromFiles(string File1, string File2, string outputDOWDFile, double timeTolerance, string aliasMapping1, string aliasMapping2)

This function operates like the GenerateDOWD functional attribute except that observations to be used in the differencing operations are pulled from two specified input files. It performs the differences in the sense of (File2 – File1).

The function needs the optional aliasMapping arguments, which function like the AliasMapping options in the Scenario Measurements.Files list, when the input files specify tracking IDs as strings. The CCSDS TDM format is a commonly used tracking data format that supplies tracking IDs as strings.

Parameters

File1 string Enter the path of the first input observations file.
File2 string Enter the path of the second input observations file.
outputDOWDFile string

Enter the path of the output file (type: gobs).
timeTolerance double Specify the allowed time difference, in seconds, between time tags for observations to be considered simultaneous.
aliasMapping1 string Enter the tracking data format for alias mapping for the tracking IDs for File1.
aliasMapping2 string Enter the tracking data format for alias mapping for the tracking IDs for File2.

Return Value

bool A Boolean indicating success or not

Example VBS:

Copy 
timeTolerance = 0.0

oneWayFile1 = "C:\tmp\MyOneWayObs1.gobs"
oneWayFile2 = "C:\tmp\MyOneWayObs2.gobs"

dowdFile = "C:\tmp\MySatDOWD.gobs"
bSuccess = ODTK.GenerateDOWDFromFiles(oneWayFile1, oneWayFile2, _
                             dowdFile, timeTolerance)

oneWayFile1 = "C:\tmp\MyOneWayObs1.tdm"
oneWayFile2 = "C:\tmp\MyOneWayObs2.tdm"
aliasMapping = "CCSDS"

dowdFile = "C:\tmp\MySatDOWD.gobs"
bSuccess = ODTK.GenerateDOWDFromFiles(oneWayFile1, oneWayFile2, _
                             dowdFile, timeTolerance, _
                             aliasMapping, aliasMapping)

bool GenerateICRFXYSFile(string startDateGregTDT, string stopDateGregTDT, string algorithm, string outputDirectory)

Use this to generate a set of files containing tabulated X, Y, and S angles that support interpolation during the evaluation of ICRF-to-Earth-fixed coordinate transformations. The main use of this function is to generate support files that reach further into the future than the files contained in the standard ODTK application installation (end time of 2150). ODTK processing will generate the resulting output data tables with a frequency of one row per day (TDT).

Parameters

startDateGregTDT string

Specify the desired start of the output file expressed in Gregorian format and interpreted as being in the TDT (TT) time scale. It should be at zero hours of the start day.
stopDateGregTDT string Specify the desired end of the output file expressed in Gregorian format and interpreted as being in the TDT (TT) time scale. It should be at zero hours of the final day.
algorithm bool Indicate the version of the ICRF theory you want to use. The options are "IAU2006" and "IAU2000A".
outputDirectory bool Specify the path to the directory where the ODTK application will write the output files. An execution of this method will generate two files (binary and ASCII) and name them appropriately to be recognized by Ansys Systems Tool Kit® (STK®) and ODTK applications.

Return Value

bool A Boolean indicating success or not

Example VBS:

Copy 
startDateTDT = "1 Jan 1980 00:00:00.00"
stopDateTDT = "1 Jan 2200 00:00:00.00"
algorithm = "IAU2006"
outputDirectory = "C:\Users\ODTKMaster\Documents\STK_ODTK 13\New ICRF Files"
bSuccess = ODTK.GenerateICRFXYSFile(startDateTDT, stopDateTDT, _
                                    algorithm, outputDirectory)

bool GenerateNavSolutions(string inputRinexFile, string outputNavSolFile, string GNSSConstellation)

Use this to generate a file of GNSS navigation solutions from a RINEX file. You must load a scenario with a configured GNSS constellation. This function has a last argument that takes in a string with the name of GNSS Constellation ("GPS," "GALILEO," "GLONASS," "BeiDou") that limits the algorithm to use only observations originated from GNSS satellites that belong to said constellation.

Parameters

inputRinexFile string

Specify the path to the RINEX file from which ODTK processing will take observations.
outputNavSolFile string Specify the path to the output file to which ODTK processing will write GNSS navigation solutions.
GNSSConstellation string Specify the name of the GNSS constellation from which ODTK processing will take observations.

Return Value

bool A Boolean indicating success or not

Example VBS:

Copy 
rinexFile = "C:\odtk\od_7.0\TrackingData\GpsConstTest.rnx"
navFile = "C:\tmp\Rcvr800.navsol"
bSuccess = ODTK.GenerateNavSolutions(rinexFile, navFile, "GPS")

CAgAttr GeneratePAFFile(string inputFile, string outputFile, string options)

The PAF file is the GNSS Performance Assessment File. This function takes a .difrun file as input and returns orbit and clocks errors for the GNSS satellites in the run file using data at requested intervals. The orbit errors are in the Earth Centered Earth Fixed frame in units of meters and meters/sec. The clock phase and frequency errors are also in units of meters and meters/sec. By default, it samples the data at 15-minute intervals. It processes only one data file per run. It can write data at any start time and for any length of time, as opposed to being limited to one day starting at midnight. The GeneratePAFFile html utility calls this function.

To get GNSS orbit differences as compared to an SP3 file, first run the SP3_to_Simrun utility and difference the ODTK run of interest (filrun, simrun, or smtrun) against the SP3.simrun file. Use that as the input to generate the PAF file.

The options string is a list of arguments that contains options of the function. You specify the options by including a keyword followed by text in quotes. For example, using backtick strings in JavaScript:

  • let options = `/optionalParam1 "value1" /optionalParam2 "value2"`

Parameters

inputFile string

Enter the path to the .difrun file.
outputFile string

Enter the path to the desired PAF file.
options string

Provide a list of arguments that contains options of the function. See the table below for which parameters you can include in the options string.

options

/startTime

Specify the start GNSS time string, e.g., /startTime "03 Jan 2009 00:12:11.5".
/stopTime

Specify the stop GNSS time string, e.g., /stopTime "03 Jan 2009 11:15:21.00".
/step

Specify the step size between outputs in seconds, e.g., /step "120".
/source

Provide the source string for the header, e.g., /source "GOCGIS".
/class

Tell the function to get Satellite objects, rather than GNSSSatellite objects, in the ODTK application, e.g., /class "Satellite".

Return Value

This function returns a CAgAttr object containing the following members:

Succeed CAgAttrBool A Boolean indicating success or not
OutputFilename CAgAttrString A string showing the output filename
Messages CAgAttrString A string showing errors or other status

Example VBS:

Copy 
ifile = "C:\tmp\GNSSFinManSimpleTest.difrun"
ofile = "c:\tmp\test.paf"
Input = "/step ""900"" " & 
        "/source ""GOCGIS"" " &
        "/class ""GNSSSatellite"""
set retv = ODTK.GeneratePAFFile(ifile, ofile, input)
odtk.writemessage retv.Succeed,"force"
odtk.writemessage retv.OutputFile,"force"
odtk.writemessage retv.Messages,"force"

CAgAttr GeneratePSFFile(string inputFile, string outputFile, string options)

The PSF file is a GNSS Prediction Support File. This function takes a .filrun or .smtrun file as input and calculates RMS for the values in the PSF file using data at requested intervals. By default, it samples data at 15-minute intervals. It does not do constellation averaging if there is less than 24 hours of data in the file. It only processes one data file per run, so for a seven-day average, the function requires a single run file containing seven days of data. The GeneratePSFFile html utility calls this function.

The options string is a list of arguments that contains options of the function. You specify the options by including a keyword followed by text in quotes. For example, using backtick strings in JavaScript:

  • let options = `/optionalParam1 "value1" /optionalParam2 "value2"`

Parameters

inputFile string

A path to the .filrun or .simrun file
outputFile string

A path to the desired PSF file
options string

A list of arguments that contains options of the function; see table below for what parameters you can include in the options string

options

/startTime

The start GNSS time string, e.g., /startTime "03 Jan 2009 00:12:11.5"
/stopTime

The stop GNSS time string, e.g., /stopTime "03 Jan 2009 11:15:21.00"
/step

The sampling interval in seconds, e.g., /step "120".
/source

The source string for the header, e.g., /source "GOCGIS"

Return Value

This function returns a CAgAttr object containing the following members:

Succeed CAgAttrBool A Boolean indicating success or not
OutputFilename CAgAttrString A string showing the output filename
Messages CAgAttrString A string showing errors or other status

Example VBS:

Copy 
ifile = "C:\tmp\GNSSFinManSimpleTest.filrun"
ofile = "c:\tmp\test.psf"
Input = " /step ""900"""
set retv = ODTK.GeneratePSFFile(ifile, ofile, input)
odtk.writemessage retv.Succeed,"force"
odtk.writemessage retv.OutputFile,"force"
odtk.writemessage retv.Messages,"force"

CAgAttr GenerateSP3FromStateHistory(string inputs)

This is a helper function for the StateFile_To_SP3 utility. It returns the contents of a state history file to an SP3 file.

The inputs string is a list of arguments that contains options of the function. You specify the options by including a keyword followed by text in quotes. For example, using backtick strings in JavaScript:

  • let inputs = `/filename "filename" /optionalParam1 "value1" /optionalParam2 "value2"`

. /filename is the only required argument. All other parameters are optional.

Note:

  • If you do not specify an output file, the function will create one using an .sp3 extension in the same directory as the input file.

  • If you do not specify a start or stop time, the function will dump the entire file contents.

  • If you specify a start time without the stop time, the function will only dump data at that single time.

  • The output file will follow the SP3a format only if it includes GPS satellites. If it includes satellites from another GNSS system, the output file will follow the SP3c format.

Parameters

inputs string A list of arguments that contains options of the function, including a keyword followed by text in quotes for each option

Inputs Options

/output The path to the desired output file name, e.g., /output "c:\myFile.sp3"
/startTime The start GNSSG time string, e.g., /startTime "03 Jan 2009 00:00:00"
/stopTime The stop GNSSG time string, e.g., /stopTime "03 Jan 2009 11:15:00.00"
/step The step size between outputs in seconds, e.g., /step "120"

Return Value

This function returns a CAgAttr containing the following members:

Succeed

A Boolean indicating if file was read or not
OutputFilename A string showing the output filename
Messages A string showing errors or other status

Example VBS:

Copy 
input = "/filename " & """C:\tmp\GNSSFinManTest.filrun"""
set retv = ODTK.GenerateSP3FromStateHistory(input)
odtk.writemessage retv.Succeed,"force"
odtk.writemessage retv.OutputFile,"force"
odtk.writemessage retv.Messages,"force"

CAgAttr GenerateTLE(string ephemFile, string startTime, string stopEntry, double step, double convergence, int maxIterations, string idString, string TLEFile, string reportName, string SGP4ModuleName, bool UseSGP4XPOption)

This is a helper function for the OD GenerateTLE utility. It generates a TLE file that results from a least squares fit to the ephemeris from the input file.

Parameters

ephemFile string Provide the path for the input ephemeris (*.e) file name.
startTime string Specify the TLE epoch in UTCG.
stopEntry string

Combines the stop method and value using the formula "Method+Value". It has three choices for Method:

  • SPAN: Its value is the time span in minutes, e.g., "SPAN+120", and will fit a two-hour section of ephemeris.

  • REVS: Its value is an integer number of orbits, e.g., "REVS+3", and will fit over three orbit periods.

  • TIME: Its value is the stop time string in UTCG.
step double Defines how often to sample the ephemeris A value of 0 tells the function to use all the available points in the file.
convergence double Use this when iterating for a solution.
maxIterations int Specify the maximum number of iterations.
idString string

Combines different identifier strings in the formula "revNum+elemNum+SSCNum+classification+internationalDesignation". It combines four values that are defined within a TLE:

  • revNum defines the pass number at the TLE epoch.

  • elemNum is an integer value set in the file.

  • SSCNum is the five-digit identifier string.

  • classification is a string with "U", meaning unclassified.

  • intlDesig is the international designation string.
TLEFile string Provide the path to the output file containing the TLE.
reportName string Provide the path to an output file containing a summary report with residual information for each iteration.
SGP4ModuleName string (Optional) Provide an argument specifying the name of the SGP4 implementation to use. The default is "SGP4," and it is the only option unless you install SGP4 plugin modules.
UseSGP4XPOption bool (Optional) Provide an argument that is only valid if you install the Air Force version 8 (or later) SGP4 plugin. The flag indicates whether or not to use the XP form of the SGP4 algorithm when generating TLEs.

Return Value

This function returns a CAgAttr containing the following members:

FitStartTime A UTCG string
FitStopTime A UTCG string
FinalRMS A double showing final residual RMS
ErrorMsg A string showing final status or errors
Succeed

A Boolean indicating if file was read or not

Example VBS:

Copy 
eFile = "c:\tmp\s3.e"
t1 = "11 Jul 2010 00:10:00.000"
t2s = "TIME+11 Jul 2010 06:00:00.000"
dt = 0
conv = .001
maxIt = 5
idString = "33+1+55432+U+ "
tleFile = "c:\tmp\s37.tle"
rptFile = "c:\tmp\s3_tle7.txt"
moduleName = "SGP4"
useXPOption = "false"
set retv = odtk.GenerateTLE(eFile, t1, t2s, dt, conv, _
                            maxIt, idString, tleFile, _
                            rptFile, moduleName, useXPOption)
odtk.WriteMessage retv.Succeed, "force"
odtk.writeMessage retv.errorMsg, "force"
odtk.writeMessage retv.fitstarttime, "force"
odtk.writeMessage retv.fitstoptime, "force"
odtk.writeMessage retv.finalRMS, "force"

CAgAttr GetBoundaryRunFileTimes(string runFileName)

This function returns the earliest and latest times that are present in a run file.

Parameters

runFileName string The path to a .filrun, .simrun, or .smtrun file

Return Value

This function returns a CAgAttr containing the following members:

Succeed

A Boolean indicating if file was read or not
StartTime The first time in the run file, only set if runFilename is not empty
StopTime The last time in the run file, only set if runFilename is not empty

Example JavaScript:

Copy 
const simulator = sc.Simulator;
const runFile = simulator.Output.DataArchive.Filename.value();
const boundaryTimesRet = ODTK.Application.GetBoundaryRunFileTimes(runFile);
const success = boundaryTimesRet.Succeed.value();
const startTime = boundaryTimesRet.StartTime.value();
const stopTime = boundaryTimesRet.StopTime.value();

CAgAttr GetCBNames(string inputRunFile)

This function analyzes an input run file and determines which central bodies are referenced within that run file.

Parameters

inputRunFile string The path to a .filrun, .simrun, or .smtrun file

Return Value

This function returns a CAgAttr containing the following members:

Succeed

A Boolean indicating if file was read or not
CBNames A set of strings containing the central body names

Example VBS:

Copy 
eFile = "c:\tmp\scenario1.filrun"
set retv = odtk.GetCBNames(eFile)
odtk.WriteMessage retv.Succeed, "force"
odtk.writeMessage retv.CBNames.size, "force"
for each thing in retv.CBNames
    odtk.writeMessage thing, "force"
next

CAgAttr GetCoordSysNames(string cbName)

This provides the valid coordinate system names for a central body, which could be "Earth", "Moon", or "Sun".

Parameters

cbName string The central body name

Return Value

This function returns a CAgAttr containing the following members:

Succeed

A Boolean indicating if file was read or not
CoordSystems A set of strings containing the coordinate system names

Example VBS:

Copy 
set retv = odtk.GetCoordSysNames("Sun")
odtk.WriteMessage retv.Succeed, "force"
odtk.writeMessage retv.CoordSystems.size, "force"
for each thing in retv.CoordSystems
    odtk.writeMessage thing, "force"
next

CAgAttr GetEphemTimeSpan(string filename)

This gets the start and stop time of the ephemeris (.e) file.

Parameters

filename string The input ephemeris (.e) file

Return Value

This function returns a CAgAttr containing the following members:

StartTime A string containing the start time in UTCG
StopTime

A string containing the stop time in UTCG
Cov6x6

A Boolean indicating if the file contains 6x6 (position/velocity) covariance
Succeed

A Boolean indicating if file was read or not

Example VBS:

Copy 
set result = ODTK.GetEphemTimeSpan("c:\tmp\s3.e")
odtk.writeMessage result.Succeed, "debug"
odtk.writeMessage result.StartTime, "debug"
odtk.writeMessage result.StopTime, "debug"
odtk.writeMessage result.Cov6x6, "debug"

CAgAttr GetFDRecordEpoch(string recordName)

This function returns the time of a flight dynamics record.

Parameters

recordName string The name of the flight dynamics record component in the Component Browser

Return Value

This function returns a CAgAttr containing the following members:

Succeed True if the operation was successful
AvailableEpoch

A string representing the epoch of the flight dynamics record

Example JavaScript:

Copy 
const recordRet = ODTK.Application.GetFDRecordEpoch("Flight_Dynamics_Record");
const success = recordRet.Succeed.value();
const recordEpoch = recordRet.AvailableEpoch.value();

CAgAttr GetFDRecords()

This function returns a list of all the available flight dynamics records in the Component Browser.

Return Value

This function returns a CAgAttr containing the following members:

Succeed This is true if the operation was successful.
AvailableRecords

This is a list of string names of all the flight dynamics records in the Component Browser. Each flight dynamics record is an object with its own properties.

Example JavaScript:

Copy 
const recordsRet = ODTK.Application.GetFDRecords();
const success = recordsRet.Succeed.value();
const recordList = recordsRet.AvailableRecords;

CAgAttr GetRestartObjects(string restartMetaFile, string time)

This function returns a list of the available satellites within a restart record at a given time.

Parameters

restartMetaFile string The file under the Restart directory of the form <object>_<scenarioName>.bin
time string A string representing the time of the restart record you are interested in

Return Value

This function returns a CAgAttr containing the following members:

Succeed True if the operation was successful
AvailableSatellites

A list of the satellites that have data in the restart record at that time

Example JavaScript:

Copy 
const restartMetaFile = ODTK.Application.GetRestartPath(sc.Name.value(),"Simulator1").RestartPath.value();
const restartObjectRet = ODTK.Application.GetRestartObjects(restartMetaFile,"1 Jul 2024 13:00:00.000");
const success = restartObjectRet.Succeed.value();
const restartObjectList = restartObjectRet.AvailableSatellites;

CAgAttr GetRestartPath(string scenName, string objectName)

This returns the path to the restart record metadata file for an object in a scenario.

Parameters

scenName string The name of scenario where the desired restart record was created
objectName string The name of the object within the scenario

Return Value

This function returns a CAgAttr containing the following members:

Succeed True if the operation was successful
RestartPath

The filepath to the restart metadata file

Example JavaScript:

Copy 
const restartPathRet = ODTK.Application.GetRestartPath(sc.Name.value(),"Simulator1");
const success = restartPathRet.Succeed.value();
const restartPath = restartPathRet.RestartPath.value();

CAgAttr GetRestartStateConfig(string restartMetaFile, string time, string satName)

This returns a flight dynamics state configuration object for a satellite from a restart record at a particular time.

Parameters

restartMetaFile string The file under the Restart directory of the form <object>_<scenarioName>.bin
time string A string representing the time of the restart record you are interested in
satName string The name of the satellite object you’re interested in

Return Value

This function returns a CAgAttr containing one or six members depending on whether or not all inputs have values:

Succeed The value is True if the operation was successful.
CentralBody

This is the central body associated with the state and is only present if all inputs have values.
StateConfig This is the state config object. This object has properties defined by the state configuration component of the Flight Dynamics Record. It contains the satellite’s state, and its fields may vary depending on the content of the state. It is only present if all inputs have values.
PropagatorName This is the name of the propagator component used to propagate the satellite and is only present if all inputs have values.
KeplerianElems These are the values of the six Keplerian elements of the orbit and is only present if all inputs have values.
RICCovariance This is the covariance matrix elements in the radial/in-track/cross-track reference frame and is only present if all inputs have values.

Example JavaScript:

Copy 
const restartMetaFile = ODTK.Application.GetRestartPath(sc.Name.value(),"Simulator1").RestartPath.value();
const restartStateConfigRet = ODTK.Application.GetRestartStateConfig(restartMetaFile,
                                                                     "1 Jul 2024 13:00:00.000",
                                                                     "Satellite1");
const success = restartStateConfigRet.Succeed.value();
const centralBody = restartStateConfigRet.CentralBody.value();
const stateConfig = restartStateConfigRet.StateConfig;
const propagatorName = restartStateConfigRet.PropagatorName.value();
const keplerianElems = restartStateConfigRet.KeplerianElems;
const ricCovariance = restartStateConfigRet.RICCovariance;

CAgAttr GetRestartTimes(string restartMetaFile)

This returns the list of times available within a restart record when given the filename of the restart record metadata file.

Parameters

restartMetaFile string The file under the Restart directory of the form <object>_<scenarioName>.bin

Return Value

This function returns a CAgAttr containing the following members:

Succeed True if the operation was successful
AvailableTimes

A list of the times where the object has restart records

Example JavaScript:

Copy 
const restartMetaFile = ODTK.Application.GetRestartPath(sc.Name.value(),"Simulator1").RestartPath.value();
const restartTimeRet = ODTK.Application.GetRestartTimes(restartMetaFile);
const success = restartTimeRet.Succeed.value();
const restartTimeList = restartTimeRet.AvailableTimes;

CAgAttr GetRunFileObjects(string runFileName, string timeMode, string desiredTimeStr)

This returns a list of satellites that have data in a run file at a given time.

Parameters

runFileName string Enter the path to a .filrun, .simrun, or .smtrun file.
timeMode string Enter one of the following: First, Last, Closest, ClosestBefore, or ClosestAfter. This determines how the function chooses a time from the run file.
desiredTimeStr string Specify a string representing the time of the desired state.

Return Value

This function returns a CAgAttr containing the following members:

Succeed This is true if the operation was successful.
AvailableSatellites

This is a list of the satellites at the chosen time point.

Example JavaScript:

Copy 
const simulator = sc.Simulator(0);
const runFile = simulator.Output.DataArchive.Filename.value();
const runFileObjRet = ODTK.Application.GetRunFileObjects(runFile, "Closest", "1 Jul 2024 14:30:00.000");
const success = runFileObjRet.Succeed.value();
const availableSats = runFileObjRet.AvailableSatellites;

CAgAttr GetRunFileStateConfig(string runFileName, string timeMode, string desiredTimeStr, string satName)

This returns a flight dynamics state configuration object for a satellite from a run file at a particular time.

Parameters

runFileName string Provide the path to a .filrun, .simrun, or .smtrun file.
timeMode string Choose one of the following: First, Last, Closest, ClosestBefore, or ClosestAfter. This determines how the function chooses a time from the run file.
desiredTimeStr string Enter a string representing the time of the desired state.
satName string Enter the name the satellite to create the state configuration component from.

Return Value

This function returns a CAgAttr containing one or six members depending on whether or not all inputs have values:

Succeed This is true if the operation was successful.
CentralBody

This is the central body associated with the state and is only present if all inputs have values.
StateConfig This is the state config object. This object has properties defined by the state configuration component of the Flight Dynamics Record. It contains the satellite’s state, and its fields may vary depending on the content of the state. It is only present if all inputs have values.
PropagatorName This is the name of the propagator component used to propagate the satellite and is only present if all inputs have values.
KeplerianElems This is the values of the six Keplerian elements of the orbit and is only present if all inputs have values.
RICCovariance This is the covariance matrix elements in the radial/in-track/cross-track reference frame and is only present if all inputs have values.

Example JavaScript:

Copy 
const simulator = ODTK.Scenario1.Simulator1.Simulator;
const runFile = simulator.Output.DataArchive.Filename.value();
const runFileStateConfigRet = ODTK.Application.GetRunFileStateConfig(runFile,"Closest", "1 Jul 2024 14:30:00.000", "Satellite1");
const success = runFileStateConfigRet.Succeed.value();
const centralBody = runFileStateConfigRet.CentralBody.value();
const stateConfig = runFileStateConfigRet.StateConfig;
const propagatorName = runFileStateConfigRet.PropagatorName.value();
const keplerianElems = runFileStateConfigRet.KeplerianElems;
const ricCovariance = runFileStateConfigRet.RICCovariance;

CAgAttr GetSatCoordFrameChoices(string referenceFile, string primarySat)

This is a helper function called by the CreateEphFileTool html page. It identifies the coordinate frame choices for the satellite of interest.

Parameters

referenceFile string The path to the run file to extract ephemeris from
primarySat string The name of the satellite object in the file

Return Value

This function returns a CAgAttr containing the following members:

Succeed A Boolean indicating success or not
CB

A string identifying the satellite central body
DefaultCoordFrame A string identifying the default coordinate frame for this satellite central body
CoordFrameChoices A list of strings identifiying the choices for coordinate frame selection
Messages A string showing errors or other status

Example VBS:

Copy 
refFile = "C:\tmp\Scenario1.filrun"
sat = "Sat3"
set retv = ODTK.GetSatCoordFrameChoices(refFile, sat)
odtk.writemessage retv.Succeed,"force"
odtk.writemessage retv.CB,"force"
odtk.writemessage retv.DefaultCoordFrame,"force"
odtk.writemessage retv.Messages,"force"
set frameChoices = retv.CoordFrameChoices
for each frame in frameChoices
odtk.writemessage frame,"force"
Next

CAgAttr GetStateHistoryFileContents(string filename)

This function reads the contents of a state history file, identifying states within the file and returning a string with each state's name. The returned string is split into a number of sections, identifying whether covariance values are available, indicating satellites with position/velocity states, and listing all remaining state values.

Parameters

filename string Provide the path to the input file with one of the following extensions: *.filrun, *.smtrun, *.lstrun, or *.smtrun file.

Return Value

This function returns a CAgAttr containing the following members:

ResultMsg

This is a string showing the contents of the state history file. The ResultsMsg has up to three different portions to its string, but they always appear in the same order:

  • \hasCov is at the beginning of the string if the state history file has covariance information. If it does not, this flag is absent from the string.

  • \satPosStates precedes a comma-delimited list of all satellites that have orbit position states.

  • \states precedes a comma-delimited list of all other states.
ProcessMsg This is a string showing errors or other status.
Succeed This is a Boolean indicating success or not.

Example VBS:

Copy 
filename = "C:\od_7.0\TrackingData\scenario.filrun"
ODTK.GetStateHistoryFileContents filename

bool GNSSDataSmoothing(string outputFile, int nPoints, double minSNR, double rng3DiffTest, double phase3DiffTest)

Use this to generate a smoothing observation file from GNSS accumulated-delta-range-aided pseudorange measurements using the assigned tracking files in the Scenario object. The GenerateGNSSSPRObs html utility calls this function.

Parameters

outputFile string Contains the new measurements. The file extension must support the output measurement type.
nPoints int

Specify the number of phase measurements to smooth.
minSNR double Specify the signal-to-noise ratio threshold.
rng3DiffTest double Specify the pseudo-range third-difference test value, where 0 implies there is no test.
phase3DiffTest double Specify the phase third-difference test value, where 0 implies there is no test.

Return Value

bool This Boolean is false if it cannot create the output file. The ODTK application writes all status and error messages to the message viewer.

Example VBS:

Copy 
outFile = "C:\Tmp\GNSSSPRObs.gobs"
bRes = ODTK.GNSSDataSmoothing(outFile, 5, 0, 0, 0)
odtk.WriteMessage bRes, "force"

CAgAttr HostID()

Use this to get the host ID, such as 001fa435ab78.

Return VAlue

CAgAttr

Contains a string with the host ID.

Example VBS:

Copy 
ODTK.WriteMessage ODTK.HostID, "force"

bool ImportFDRecordToSat(string satName, string recordName)

This function imports a chosen flight dynamics record into a specified satellite.

Parameters

satName string

The name of the satellite to import the record data into
recordName string

The name of the flight dynamics record to import into the satellite

Return VAlue

bool

True if the operation was successful and false otherwise

Example JavaScript:

Copy 
const success = ODTK.Application.ImportFDRecordToSat("Satellite1", "Flight_Dynamics_Record").value();

CAgAttr InitialStateTool(string source, string filename, string command, string options)

This is a helper function for the Initial State Tool HTML interface. This function does not modify the initial state of a satellite; it parses the input file and provides information about what updates are possible based on the input. To actually update the initial conditions, you need an STK ephemeris file to pass to the satellite's ReferenceTrajectory.UpdateInitialConditions function. This function provides another useful application by calling the GetEphemTimeSpan function, which in turn calls this function.

Parameters

source string

Specify the source of the ephemeris: "EPH", "TLE", "CCSDS", or "VCM".
filename string

Provide the path to an ephemeris file (*.e | *.oem), TLE file, CCSDS OPM file, or VCM file.
command string

When source = "TLE", then command may be one of these:

  • an empty string ("") that will be used to provide a list of choices

  • "GEN" that will generate ephemeris in the *.e format
options string

Use this when source = "TLE" or "VCM".

When source = "TLE", the options string may contain one or more of the following:

  • /ssc - This is the SSC number of the desired TLE, required for ephemeris generation.

  • /epoch - This is the epoch of the desired TLE in YYDDD.DDDDDDDD format. If omitted, the function uses the first TLE with a correct SSC number.

  • /start - This is the start time for ephemeris generation in Gregorian format. If omitted, the function uses the TLE epoch.

  • /duration - This is the time span for ephemeris generation, in minutes.

  • /step - This is the step size for ephemeris generation, in minutes.

When source = "VCM," the options string may contain one or more of the following:

  • /ssc - SSC number of desired VCM, required for ephemeris generation

  • /epoch - Epoch of desired VCM in UTCG, required for ephemeris generation

Return VAlue

CAgAttr

If source is "VCM," this function reads the physical data from the VCM file and converts the initial state in the VCM file to an STK ephemeris file containing a single ephemeris point. This function then returns an object with these members:

  • DragCoeff is a double containing the Drag coefficient.

  • SRPCoeff is a double containing the SRP coefficient.

  • STKFile is an STK ephemeris file containing the VCM initial vector.

  • Succeed is a Boolean indicating success or failure of the operation.

If source is "EPH", the function returns an object with these members:

  • StartTime is a string containing the start time in UTCG.

  • StopTime is a string containing the stop time in UTCG.

  • Cov6x6 is a Boolean indicating the availability of a full 6x6 covariance in the ephemeris file.

  • CentralBody is a string containing the name of the central body in the file.

  • Succeed is a Boolean indicating success or failure of the operation.

If source is "TLE", the function returns an object with these members:

  • TLEOutput is a string containing the name of the file containing either the TLE choices or the ephemeris generated for a specific SSC.

  • Succeed is a Boolean indicating success or failure of the operation.

If source is "CCSDS", this function reads the physical data from the OPM file and converts the initial state in the OPM file to an STK ephemeris file containing a single ephemeris point. This function then returns an object with these members:

  • StartTime is a string containing the start time in UTCG.

  • StopTime is a string containing the stop time in UTCG.

  • Cov6x6 is a Boolean indicating availability of a full 6x6 covariance in ephemeris file.

  • CentralBody is a string containing the name of the central body in the file.

  • Massis a double containing the mass of the satellite in kilograms.

  • DragCoeff is a double containing the drag coefficient.

  • DragArea is a double containing the drag area in square meters.

  • SRPCoeff is a double containing the SRP coefficient.

  • SRPArea is a double containing the SRP area in square meters.

  • STKFile is an STK ephemeris file containing the OPM initial vector.

  • Succeed is a Boolean indicating success or failure of the operation.

Example VBS:

Copy 
efile = "c:\tmp\MySat.e"
set retv = ODTK.InitialStateTool("EPH", efile,"","")
odtk.writemessage retv.starttime, "debug"
odtk.writemessage retv.stoptime, "debug"
odtk.writemessage retv.cov6x6, "debug"
odtk.writemessage retv.succeed, "debug"
odtk.writemessage retv.CentralBody, "debug"

bool IsPasteAvailable(CAgAttr parentObject)

This returns a flag indicating whether or not contents of the clipboard can be pasted as a child of the specified parent object. It is used in conjunction with the CopyObject and PasteObject commands.

Parameters

parentObject CAgAttr

The parent object being evaluated as a possible parent to a child object which is in the clipboard

Return Value

Succeed

A Boolean indicating success or not

Example VBS:

Copy 
bCanPaste = ODTK.IsPasteAvailable(sc)

CAgAttr LambertSolution(CAgAttr date1, CAgAttr pos1, CAgAttr date2, CAgAttr pos2)

This computes the Lambert Solutions found, given a pair of radial positions separated in time. Two calls to the helper function NewPositionVector must precede this function.

Parameters

date1 CAgAttr

A date object that is the time of the first position
pos1 CAgAttr

The NewPositionVector object for the first position
date2 CAgAttr

A date object for the second position
pos2 CAgAttr The NewPositionVector object for the second position

Return Value

The function returns a CAgAttr containing the following members:

Succeed

A Boolean that is false if there are no solutions
nSol

The integer number of solutions found (0, 1, or 2)
ErrorMsg

A string containing an error message, or blank
v11

Contains the velocity components at time 1 for the first solution:

  • X: X velocity component (quantity)

  • Y: Y velocity component (quantity)

  • Z: Z velocity component (quantity)
v12

Contains the velocity components at time 2 for the first solution:

  • X: X velocity component (quantity)

  • Y: Y velocity component (quantity)

  • Z: Z velocity component (quantity)
v21

Contains the velocity components at time 1 for the second solution:

  • X: X velocity component (quantity)

  • Y: Y velocity component (quantity)

  • Z: Z velocity component (quantity)
v22

Contains the velocity components at time 2 for the second solution:

  • X: X velocity component (quantity)

  • Y: Y velocity component (quantity)

  • Z: Z velocity component (quantity)

All four (v11, v12, v21, v22) are (0, 0, 0) when no corresponding solution is found.

Example VBS:

Copy 
t1 = "01 Jan 2005 00:00:00.000 UTCG"
t2 = "01 Jan 2005 00:00:10.000 UTCG"
x1 = -6078486.439
x2 =  4652611.666
x3 =  -987009.666
a1 = -6102754.834
a2 =  4634162.069
a3 =  -921914.919
set pos1 = ODTK.NewPositionVector(x1, x2, x3, "m")
set pos2 = ODTK.NewPositionVector(a1, a2, a3, "m")
set retv = ODTK.LambertSolution(t1, pos1, t2, pos2)
odtk.writeMessage retv.Succeed, "force"
odtk.writeMessage retv.nSol, "force"
odtk.writeMessage retv.v11.X.GetIn("km*sec^-1"), "force"
odtk.writeMessage retv.v11.Y.GetIn("km*sec^-1"), "force"
odtk.writeMessage retv.v11.Z.GetIn("km*sec^-1"), "force"

CAgAttr LoadObj(CAgAttr objName, string filename)

Use this to load an object from a file. The loaded object becomes a child of the input parent object.

Parameters

objName CAgAttr

The parent of the object being loaded
filename string

The path to the file containing the object being loaded

Return Value

Succeed

True if the object was loaded

Example VBS:

Copy 
set newObj = ODTK.LoadObj(sc.Sat1,"C:\tmp\ToGround.tpd")

CAgAttr LoadStateAndCovarianceSelection(string filename)

This loads a file containing a state and covariance selection and returns that selection string. You should use this with the (*.dmpsav) extension.

This function is intended for use by the FlexibleStateFileDumperTool utility. It serves to complement the ExtractStateHistory attribute by loading a flexData string originally created and saved by the SaveStateAndCovarianceSelection attribute.

Parameters

filename string

The path to the input filename, including the file extension

Return VAlue

The function returns a CAgAttr containing the following members:

SelectionString

A string contained by the file, representing selected states and covariances
ProcessMsg A string showing errors or other status
Succeed A Boolean indicating success or not

Example VBS:

Copy 
filename = "C:\od_7.0\TrackingData\selection.dmpsav"
ODTK.LoadStateAndCovarianceSelection filename

CAgAttr NewDate(string date, string units)

Creates a new date from a string.

Valid Date Formats

Parameters

date string

The input date
units string

The desired (new) format of the input date

Return Value

newDate

The date in the new format

Example VBS:

Copy 
sc.Filter(0).ProcessControl.StartTime = ODTK.NewDate("1 Aug 2009 08:05:30.00", "UTCG")
set nd = ODTK.NewDate("08183.5", "YYDDD")
ODTK.WriteMessage nd.Format("GNSSG"), "debug"

CAgAttr NewPositionVector(double x, double y, double z, string units)

This is a helper function that creates a three-component input for use by the LambertSolution function. It requires an input of three numbers and a valid unit string of length.

Parameters

x double

The X-direction component of the position
y double

The Y-direction component of the position
z double

The Z-direction component of the position
units string

The units of length for X, Y, and Z

Return Value

CAgAttr

The returned object has three members, which are quantities that are supposed to be position but have velocity units (so ignore the resulting units):

  • x: X position component

  • y: Y position component

  • z: Z position component

Example VBS:

Copy 
unitstring = "m"
x1 = -6078486.439
y1 = 4652611.666
z1 = -987009.666
set pos1 = ODTK.NewPositionVector(x1, y1, z1, unitstring)
ODTK.WriteMessage pos1.X, "debug"

CAgAttr NewQuantity(double value, string units)

Use this to create a new quantity object, which is a value with units.

Parameters

value double

The value of the new quantity
units string

The units of the new quantity

Return VAlue

CAgAttr A quantity object

Example VBS:

Copy 
sc.Satellite(0).PhysicalProperties.Mass = ODTK.NewQuantity(3567.15, "lb")
set newMass = odtk.NewQuantity("1000", "kg")
odtk.WriteMessage newMass.GetIn("lb"), "force"

bool PasteObject(CAgAttr parentObject)

This function pastes contents of the clipboard as a child of specified parent object. See also the IsPasteAvailable and CopyObject commands.

Parameters

parentObject CAgAttr

The parent object to paste the clipboard child object to

Return VAlue

bool A Boolean indicating success or not

Example VBS:

Copy 
bSuccess = ODTK.PasteObject(sc)

CAgAttr RegistrationID()

Use this to get the registration ID, such as "DISK_SERIAL_NUM=a4e217c5".

Return VAlue

CAgAttr A string registration ID

Example VBS:

Copy 
registrationIDStr = ODTK.RegistrationID

bool RunScript(string scriptName)

This function allows control of the ODTK application to be passed to an external script. The function is passed a message and the personality object. This script then has complete control over the ODTK application, with the ability to create and delete objects, generate reports, etc.

Parameters

scriptName string

A file containing a function with the signature:

Function filename(msg, ODTK)

End Function

The function name must match the filename less the extension, or else the script will not run.

Return Value

bool Always true

Example VBS:

Copy 
scriptName = "C:\tmp\MyScript.vbs"
ODTK.RunScript scriptName
Where MyScript.vbs contains the following code:
Function MyScript(msg, od)
    regID = od.RegistrationID
    od.writeMessage "RegID: " & regID, "force"
End Function

CAgAttr SaveObj(CAgAttr object, string filename, bool bSaveChildren)

Saves an object by specifying the actual object and a flag indicating whether or not to save children of the object.

Parameters

object CAgAttr

The object to be saved
filename string

The path for the output file to be saved
bSaveChildren bool

A Boolean specifying whether or not to save the child objects as well

When applied to scenarios, SaveObj will change all internal paths to point to the new location of the scenario.

Return VAlue

CAgAttr A handle to the saved object

Example VBS:

Copy 
Dim sat
sat = ODTK.SaveObj(scen.Sat1, "C:\tmp\Sat1.sao", true)

CAgAttr SaveStateAndCovarianceSelection(string filename, string selectionString)

This function creates or overwrites the file name specified with a new text file containing the selection string and with a file extension of *.dmpsav. You can load this file for future runs of the dumping utility to quickly select a desired set of states and covariances for dumping.

This function is intended for use by the FlexibleStateFileDumperTool utility. It serves to complement the ExtractStateHistory attribute by saving a flexData string to a file for retrieval by the LoadStateAndCovarianceSelection attribute.

Parameters

filename string

The path for the input file, including the file extension
selectionString string

The state and covariance selection, formatted as required for the flexData parameter of the ExtractStateHistory attribute

Return Value

Succeed CAgAttrBool A Boolean indicating success or not
ProcessMsg CAgAttrString A string showing errors or other status

Example VBS:

Copy 
filename = "C:\od_7.0\TrackingData\selection.dmpsav"
selectionString = "Satellite1.Orbit,Satellite1.AtmosphericDensity;Satellite1.Orbit"
ODTK.SaveStateAndCovarianceSelection filename, selectionString

CAgAttr SeparateSP3(const string& inputSP3FileName)

This function supports the SeparateSP3 utility, which separates an SP3 file containing mixed constellations into multiple SP3 files, each containing data for an individual constellation.

The output files are named <inputfile>_T.<ext>

Where <inputfile> = input file name, excluding the extension.

T = G for GNSS, R for GLONASS, E for Galileo, J for QZSS, C for BeiDou

<ext> - the input file extension (sp3)

Parameters

inputSP3FileName string

The path for the input SP3 file

Return Value

Succeed CAgAttrBool A Boolean indicating success or not
FileNames CAgAttrList of CAgAttrStrings The output filenames
Messages CAgAttrString A string showing errors or other status

Example VBS:

Copy 
dim inputSP3FileName
inputSP3FileName = "C:\Test\test.sp3"
set ret = mach10.Application.SeparateSP3(inputSP3FileName)
if ret.Succeed then
    set listFileNames = rec.FileNames
else
    MsgBox restartRecord.Messages
end if

CAgAttr SetAsDefault(CAgAttr object)

This function sets a specified object as the default object to be used when creating another object of that type. Default objects are saved to the Defaults folder under the Config directory.

Parameters

object CAgAttr The input object

Return Value

CAgAttr The default object if successful or an error message if not

Example VBS:

Copy 
set result = ODTK.SetAsDefault(sc.Satellite(0))

bool SortUTDF(string inputFile, string outputFile)

This function sorts a UTDF Measurement file into increasing time order. The output format will be in UTDF regardless of the extension provided.

Parameters

inputFile string The path to the source of the UTDF data
outputFile string

The path to the new UTDF file

Return Value

bool A Boolean indicating success or failure

Example VBS:

Copy 
bResult = ODTK.SortUTDF("c:\trkData.trk", "c:\trkData_sorted.trk")

bool SP3ToSimrun(string SP3File, string constellationName, string outputFile)

This is a helper function to the SP3_To_Simrun utility. It converts the GNSS orbit and clock states in the given SP3 file to a .simrun file (simulation state history file). This enables use of the ODTK State Differencing and Reporting/Graphing tools for analysis. See also the GNSSSourceToSimrun function.

Parameters

SP3File string The path to the input SP3 file to be converted
constellationName string

The name used to label objects in the simrun file, which should match whatever you intend to compare against
outputFile string The path to the file name for the new simrun file

Return Value

bool A Boolean indicating success or failure

Example VBS:

Copy 
sp3Input = "C:\tmp\input.sp3"
outputFile = "c:\tmp\gpsSource.simrun"
bResult = ODTK.SP3toSimRun(sp3Input, "GNSS", outputFile)

bool WriteMessage(string message, string status)

This function writes text to the Message Viewer window, allowing scripts to write informational messages, warnings, etc. Each type of message (warning, error, informational, and debug) will have a unique icon next to it in the message viewer.

Parameters

message string The string to be written
status string

The category of the message and must be one of the following strings:

  • "debug" - a debug message

  • "forceinfo" or just "force" - an informational message

  • "warning" - a warning message

  • "error" or "alarm" - an error message

Return Value

bool A Boolean that is true if a message is written

Example VBS:

Copy 
ODTK.WriteMessage "Hello World", "error"
odtk.writeMessage sc.Satellite(0).Name, "force"