String.EpochScan Method

Signatures

Return Value

Description

String.EpochScan()

Variable

Converts the calendar-based epoch specified by the String into a numeric time system. By default, this method will assume the String is formatted in the standard FreeFlyer calendar format ("Mmm DD YYYY hh:mm:ss.fs") in UTC, and convert the time to the TAI numeric time system.

String.EpochScan(String formatString)

Variable

Converts the calendar-based epoch specified by the String into the TAI 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 reference time "Jan 01 2000 00:00:00.000" (epoch 21544.500370370).

String.EpochScan(String formatString, String referenceTimeString)

Variable

Converts the calendar-based epoch specified by the String into the TAI 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 string specified by referenceTimeString. If a reference time string is not specified, the time "Jan 01 2000 00:00:00.000" (epoch 21544.500370370) will be used.

String.EpochScan(String formatString, Variable referenceTimeVariable)

Variable

Converts the calendar-based epoch specified by the String into the TAI 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 referenceTimeVariable Variable. If a reference time is not specified, the time "Jan 01 2000 00:00:00.000" (epoch 21544.500370370) will be used.

String.EpochScan(String formatString, String referenceTimeString, String timeSystemConversion)

Variable

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 String in UTC, and an output Variable in UT1 time, the timeSystemConversion would be "UTC-UT1".

String.EpochScan(String formatString, Variable referenceTimeVariable, String timeSystemConversion)

Variable

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 referenceTimeVariable Variable. If a reference time 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 String in UTC, and an output Variable in UT1 time, the timeSystemConversion would be "UTC-UT1".