TimeUtilities.ConvertToLocalCalendarDate(TimeSpan, String, String, Variable, String) Method

Top 

Description

Returns a local calendar String in the format specified by calendarFormat of the date and time represented by the input time value. The allowed patterns are documented in the "Date and Time Format Specifiers" tables on the "Parsing Dates and Times" page in the Help File. Note that arbitrary text can be included in the pattern by surrounding the text with double asterisks.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Method Signature

TimeUtilities.ConvertToLocalCalendarDate(

TimeSpan time,


String timeSystem,


String timeReference,


Variable timeZone,


String calendarFormat)

 

 

Arguments

time


Description:

The time to convert to a calendar date.

Units:

day

 

 

timeSystem


Description:

The system of the input time.

Valid Values:

Value

Label

"TAI"

International Atomic Time

"UTC"

Coordinated Universal Time

"TDT"

Terrestrial Dynamical Time

"TDB"

Barycentric Dynamical Time

"UT1"

Universal Time Principle Form

"GPS"

Global Positioning System Time

 

 

 

timeReference


Description:

The reference of the input time.

Valid Values:

Value

Label

"Julian Date"

Julian Date (Jan 1 4713 BCE 12:00:00.000 TAI)

"MJD GSFC"

GSFC Modified Julian Date (Jan 05 1941 12:00:00.000 TAI)

"MJD USNO"

USNO Modified Julian Date (Nov 17 1858 00:00:00.000 TAI)

"MJD GPS"

GPS Modified Julian Date (Jan 06 1980 00:00:00.000 UTC)

"MJD 1950"

Besselian Date 1950.0 (Dec 31 1949 22:09:46.862 TAI)

 

 

 

timeZone


Description:

The UTC offset of the desired local time.

Valid Values:

Value

Label

0

UTC - 12:00

1

UTC - 11:00

2

UTC - 10:00

3

UTC - 09:30

4

UTC - 09:00

5

UTC - 08:00 (PST)

6

UTC - 07:00 (MST, PDT)

7

UTC - 06:00 (CST, MDT)

8

UTC - 05:00 (CDT, EST)

9

UTC - 04:30

10

UTC - 04:00 (EDT)

11

UTC - 03:30

12

UTC - 03:00

13

UTC - 02:00

14

UTC - 01:00

15

UTC +/- 00:00

16

UTC + 01:00

17

UTC + 02:00

18

UTC + 03:00

19

UTC + 03:30

20

UTC + 04:00

21

UTC + 04:30

22

UTC + 05:00

23

UTC + 05:30

24

UTC + 05:45

25

UTC + 06:00

26

UTC + 06:30

27

UTC + 07:00

28

UTC + 08:00

29

UTC + 08:45

30

UTC + 09:00

31

UTC + 09:30

32

UTC + 10:00

33

UTC + 10:30

34

UTC + 11:00

35

UTC + 11:30

36

UTC + 12:00

37

UTC + 12:45

38

UTC + 13:00

39

UTC + 14:00

 

 

 

calendarFormat


Description:

Specifies the format of the output String. The format specification can include the date and time formats shown in the in the "Date and Time Format Specifiers" tables on the "Parsing Dates and Times" page in the Help File, including month, day, year, hours, minutes, and seconds. The user can also include custom characters by surrounding them with **asterisks**. If a format string is not specified, the format "Mmm DD YYYY hh:mm:ss.fs" will be used.

 

 

 

Return Value

Type:

string

 

 

Returns a formatted calender String in the local time system of the date and time represented by the input time value.

 

Syntax

myString1 = TimeTools.ConvertToLocalCalendarDate(myTimeSpan1, myString2, myString3, myVariable1, myString4);

 

 

See also

TimeUtilities Object

TimeUtilities.ConvertToLocalCalendarDate

TimeSpans Guide

Parsing Dates and Times