Scenario Measurements Scope Functions

The following methods are designed to support the verification and saving of observation files into another file and/or format.

bool HaveMoreObs()

Use this to check whether more measurements are available or not.

Return Value

bool A Boolean that is true if more measurements are available and false if there are none

Example VBS:

Copy 
ODTK.WriteMessage sc.Measurements.HaveMoreObs, "debug"

PreviewTrackingDataStructure PreviewTrackingData()

This function previews tracking data from the input tracking data file(s). It writes summary information to the Message Viewer, showing both file-by-file and overall summaries of the number of measurements and time span, as well as the names of trackers and satellites based on tracking IDs. If it cannot resolve the tracking IDs from the files to objects loaded in the scenario, then it shows the tracking ID.

Return Value

The function returns a PreviewTrackingDataStructure object that contains the following members:

Succeed bool True or False
TotalObsCount int The total number of observations
StartTime AgDate The time of the earliest measurement
StopTime AgDate The time of the latest measurement
TrackerSetStr string Space-delimited list of trackers
SatSetStr string Space-delimited list of satellites
FacSetStr string Space-delimited list of facilities
CentralBodySetStr string Space-delimited list of target central bodies
MeasFile list
  • List of measurement parameters:
    • FileName - string path
    • ObsCount - integer
    • StartTime - AgDate
    • StopTime - AgDate
    • TrackerSetStr - space-delimited list of trackers
    • SatSetStr - space-delimited list of satellites
    • FacSetStr - space-delimited list of target central bodies
    • CentralBodySetStr - space-delimited list of target central bodies

    Example JavaScript:

    Copy 
    let previewTracking = scen.Measurements.PreviewTrackingData();

    bool Reset()

    This function resets measurement files to the beginning. You should do this before saving observations.

    Return Value

    bool Always true

    Example VBS:

    Copy 
    sc.Measurements.Reset

    bool SaveObs(string fileName)

    Use this to save measurements to a file. If it can create the input file and the file format can accept the measurements, it saves the measurements to that file path.

    Before calling SaveObs, use VerifySaveObsMeasTypes to determine if the format is valid. It saves only those measurements that can be written to the specified format.

    Parameters

    fileName string A path to the file you want to save measurements to

    Return Value

    bool Always true

    Example VBS:

    Copy 
    bResult = sc.Measurements.SaveObs("c:\tmp\savedMeasFile.gobs")

    bool SetValidation(bool bValidate)

    This function enables/disables measurement validation based on the input flag. Validation refers here to considering measurements that are applicable to a loaded scenario. For instance, if your scenario points to a tracking data file and not all of the measurements are related to the objects in your scenario, and you attempt to save it with validation on, it will only save the measurements related to your scenario. If you turn off validation, then it will save all of the measurements. Turning validation off will make saving measurements faster. The validation setting has no effect on the application of the scenario's Measurements.ViewAndSave.CustomDataEdting attributes. If you define and enable a schedule, it will be applied regardless of the validation being on or off.

    Parameters

    bValidate bool Whether to enable measurement validation for the scenario

    Return Value

    bool Always true

    Example VBS:

    Copy 
    bResult = sc.Measurements.SetValidation(false)

    CAgAttr VerifySaveObsMeasTypes(string fileName)

    This function verifies the ability to save measurements to a specific file format, determining whether any are compatible with the file type specified in the input parameter file path.

    Parameters

    fileName string The input file path

    Return Value

    A CAgAttr object with the following members:

    VerifyOK bool True if verification is successful
    ErrorMsg string An error message if unsuccessful
    NumValidMeasTypes int A count of the number of valid measurement types found (0 if no valid types found)

    Example VBS:

    Copy 
    set result = sc.Measurements.VerifySaveObsMeasTypes("c:\tmp\savedMeasFile.rnx")
    odtk.writemessage result.VerifyOK, "debug"
    odtk.writemessage result.ErrorMsg, "debug"
    odtk.writemessage result.NumValidMeasTypes, "debug"