VirtualString.EpochScan(String, String, String) Method

 Top 

Description

Converts the calendar-based epoch specified by the String into a numeric time system. The format of the input String is given by formatString. The format string can include the date and time formats shown in the "Parsing Dates and Times" reference in the Help File, including month, day, year, hours, minutes, and seconds. If formatString does not fully define a time, the necessary data will be filled in using the referenceTimeString String. If a reference time string is not specified, the time "Jan 01 2000 00:00:00.000" (epoch 21544.500370370) will be used. The conversion string timeSystemConversion specifies the time system conversion that is applied. For example, for a calling VirtualString in UTC, and an output Variable in UT1 time, the timeSystemConversion would be "UTC-UT1".

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

 

Method Signature

VirtualString.EpochScan(

String formatString,

String referenceTimeString,

String timeSystemConversion)

 

 

Arguments

formatString

Description:

Specifies the format of the String object. The format string can include the date and time formats shown in the "Parsing Dates and Times" reference in the Help File, including month, day, year, hours, minutes, and seconds. If a format string is not specified, the format "Mmm DD YYYY hh:mm:ss.fs" will be used.

 

 

referenceTimeString

Description:

Specifies the reference time to use if the String object does not fully define a time. If a reference time string is not specified, the time "Jan 01 2000 00:00:00.000" will be used.

 

 

timeSystemConversion

Description:

Specifies the time system conversion to perform. If a time system conversion string is not specified, "UTC-TAI" will be used. If only one time system is specified (e.g., "TAI"), then "UTC-" is prepended to the conversion string (e.g., "UTC-TAI").

Valid Values:

Value

Label

"TAI"

TAI

"UT1"

UT1

"UTC"

UTC

"UTC-UTC"

UTC-UTC

"UTC-TAI"

UTC-TAI

"UTC-UT1"

UTC-UT1

"TAI-TAI"

TAI-TAI

"TAI-UT1"

TAI-UT1

"TAI-UTC"

TAI-UTC

"UT1-UT1"

UT1-UT1

"UT1-TAI"

UT1-TAI

"UT1-UTC"

UT1-UTC

 

 

 

 

Return Value

Type:

number

Units:

day

 

 

Returns the calendar-based epoch specified by the String in the specified numeric time system.

 

Syntax

myVariable1 = myString1.ToLowercase().EpochScan(myString2, myString3, myString4);

 

 

See also

VirtualString Object

VirtualString.EpochScan

Parsing Dates and Times