mod_datetime Module Reference

Data Types
interface	datetime

Functions/Subroutines
pure elemental type(datetime) function	datetime_constructor (year, month, day, hour, minute, second, millisecond, tz)
pure elemental integer function	getyear (self)
pure elemental integer function	getmonth (self)
pure elemental integer function	getday (self)
pure elemental integer function	gethour (self)
pure elemental integer function	getminute (self)
pure elemental integer function	getsecond (self)
pure elemental integer function	getmillisecond (self)
pure elemental real(kind=real64) function	gettz (self)
pure elemental subroutine	addmilliseconds (self, ms)
pure elemental subroutine	addseconds (self, s)
pure elemental subroutine	addminutes (self, m)
pure elemental subroutine	addhours (self, h)
pure elemental subroutine	adddays (self, d)
pure elemental character(len=23) function	isoformat (self, sep)
pure elemental logical function	isvalid (self)
type(datetime) function	now ()
pure elemental integer function	weekday (self)
pure elemental integer function	isoweekday (self)
pure elemental character(len=9) function	weekdaylong (self)
pure elemental character(len=9) function	isoweekdaylong (self)
pure elemental character(len=3) function	weekdayshort (self)
pure elemental character(len=3) function	isoweekdayshort (self)
integer function, dimension(3)	isocalendar (self)
integer function	secondssinceepoch (self)
character(len=:) function, allocatable	strftime (self, format)
pure elemental type(tm_struct) function	tm (self)
pure elemental character(len=5) function	tzoffset (self)
pure elemental type(datetime) function	utc (self)
pure elemental integer function	yearday (self)
pure elemental type(datetime) function	datetime_plus_timedelta (d0, t)
pure elemental type(datetime) function	timedelta_plus_datetime (t, d0)
pure elemental type(datetime) function	datetime_minus_timedelta (d0, t)
pure elemental type(timedelta) function	datetime_minus_datetime (d0, d1)
pure elemental logical function	gt (d0, d1)
pure elemental logical function	lt (d0, d1)
pure elemental logical function	eq (d0, d1)
pure elemental logical function	neq (d0, d1)
pure elemental logical function	ge (d0, d1)
pure elemental logical function	le (d0, d1)
pure elemental logical function, public	isleapyear (year)
pure type(datetime) function, dimension(:), allocatable, public	datetimerange (d0, d1, t)
pure elemental integer function, public	daysinmonth (month, year)
pure elemental integer function, public	daysinyear (year)
pure elemental real(kind=real64) function, public	date2num (d)
pure elemental type(datetime) function, public	num2date (num)
type(datetime) function, public	strptime (str, format)
pure elemental type(datetime) function, public	tm2date (ctime)
pure character(len=length) function	int2str (i, length)

Function/Subroutine Documentation

adddays()

pure elemental subroutine mod_datetime::adddays ( class(datetime), intent(inout) self, integer, intent(in) d )

private

Definition at line 774 of file suews_util_datetime.f95.

 
      !! Adds an integer number of dayss to self. Called by `datetime`
      !! addition (`+`) and subtraction (`-`) operators.
 
      CLASS(datetime), INTENT(inout) :: self !! `datetime` instance
      INTEGER, INTENT(in) :: d !! number of days to add
 
      INTEGER :: daysInCurrentMonth
 
      self%day = self%day + d
      DO
         daysincurrentmonth = daysinmonth(self%month, self%year)
         IF (self%day > daysincurrentmonth) THEN
            self%day = self%day - daysincurrentmonth
            self%month = self%month + 1
            IF (self%month > 12) THEN
               self%year = self%year + self%month/12
               self%month = mod(self%month, 12)
            END IF
         ELSEIF (self%day < 1) THEN
            self%month = self%month - 1
            IF (self%month < 1) THEN
               self%year = self%year + self%month/12 - 1
               self%month = 12 + mod(self%month, 12)
            END IF
            self%day = self%day + daysinmonth(self%month, self%year)
         ELSE
            EXIT
         END IF
      END DO
 

References daysinmonth().

Here is the call graph for this function:

addhours()

pure elemental subroutine mod_datetime::addhours ( class(datetime), intent(inout) self, integer, intent(in) h )

private

Definition at line 750 of file suews_util_datetime.f95.

 
      !! Adds an integer number of hours to self. Called by `datetime`
      !! addition (`+`) and subtraction (`-`) operators.
 
      CLASS(datetime), INTENT(inout) :: self !! `datetime` instance
      INTEGER, INTENT(in) :: h !! number of hours to add
 
      self%hour = self%hour + h
 
      DO
         IF (self%hour >= 24) THEN
            CALL self%addDays(self%hour/24)
            self%hour = mod(self%hour, 24)
         ELSEIF (self%hour < 0) THEN
            CALL self%addDays(self%hour/24 - 1)
            self%hour = mod(self%hour, 24) + 24
         ELSE
            EXIT
         END IF
      END DO
 

addmilliseconds()

pure elemental subroutine mod_datetime::addmilliseconds ( class(datetime), intent(inout) self, integer, intent(in) ms )

private

Definition at line 675 of file suews_util_datetime.f95.

 
      !! Adds an integer number of milliseconds to self. Called by `datetime`
      !! addition (`+`) and subtraction (`-`) operators.
 
      CLASS(datetime), INTENT(inout) :: self !! `datetime` instance
      INTEGER, INTENT(in) :: ms !! number of milliseconds to add
 
      self%millisecond = self%millisecond + ms
 
      DO
         IF (self%millisecond >= 1000) THEN
            CALL self%addSeconds(self%millisecond/1000)
            self%millisecond = mod(self%millisecond, 1000)
         ELSEIF (self%millisecond < 0) THEN
            CALL self%addSeconds(self%millisecond/1000 - 1)
            self%millisecond = mod(self%millisecond, 1000) + 1000
         ELSE
            EXIT
         END IF
      END DO
 

addminutes()

pure elemental subroutine mod_datetime::addminutes ( class(datetime), intent(inout) self, integer, intent(in) m )

private

Definition at line 726 of file suews_util_datetime.f95.

 
      !! Adds an integer number of minutes to self. Called by `datetime`
      !! addition (`+`) and subtraction (`-`) operators.
 
      CLASS(datetime), INTENT(inout) :: self !! `datetime` instance
      INTEGER, INTENT(in) :: m !! number of minutes to add
 
      self%minute = self%minute + m
 
      DO
         IF (self%minute >= 60) THEN
            CALL self%addHours(self%minute/60)
            self%minute = mod(self%minute, 60)
         ELSEIF (self%minute < 0) THEN
            CALL self%addHours(self%minute/60 - 1)
            self%minute = mod(self%minute, 60) + 60
         ELSE
            EXIT
         END IF
      END DO
 

addseconds()

pure elemental subroutine mod_datetime::addseconds ( class(datetime), intent(inout) self, integer, intent(in) s )

private

Definition at line 702 of file suews_util_datetime.f95.

 
      !! Adds an integer number of seconds to self. Called by `datetime`
      !! addition (`+`) and subtraction (`-`) operators.
 
      CLASS(datetime), INTENT(inout) :: self !! `datetime` instance
      INTEGER, INTENT(in) :: s !! number of seconds to add
 
      self%second = self%second + s
 
      DO
         IF (self%second >= 60) THEN
            CALL self%addMinutes(self%second/60)
            self%second = mod(self%second, 60)
         ELSEIF (self%second < 0) THEN
            CALL self%addMinutes(self%second/60 - 1)
            self%second = mod(self%second, 60) + 60
         ELSE
            EXIT
         END IF
      END DO
 

date2num()

pure elemental real(kind=real64) function, public mod_datetime::date2num

(

type(datetime), intent(in)

d

)

Definition at line 1504 of file suews_util_datetime.f95.

 
      !! Given a datetime instance d, returns number of days since
      !! `0001-01-01 00:00:00`, taking into account the timezone offset.
 
      TYPE(datetime), INTENT(in) :: d !! `datetime` instance
 
      TYPE(datetime) :: d_utc
      INTEGER :: year
 
      ! Convert to UTC first
      d_utc = d%utc()
 
      ! d_utc % year must be positive:
      IF (d_utc%year < 1) THEN
         date2num = 0
         RETURN
      END IF
 
      date2num = 0
      DO year = 1, d_utc%year - 1
         date2num = date2num + daysinyear(year)
      END DO
 
      date2num = date2num &
                 + d_utc%yearday() &
                 + d_utc%hour*h2d &
                 + d_utc%minute*m2d &
                 + (d_utc%second + 1e-3_real64*d_utc%millisecond)*s2d
 

References date2num(), and daysinyear().

Referenced by date2num(), datetime_minus_datetime(), and datetimerange().

Here is the call graph for this function:

Here is the caller graph for this function:

datetime_constructor()

pure elemental type(datetime) function mod_datetime::datetime_constructor ( integer, intent(in), optional year, integer, intent(in), optional month, integer, intent(in), optional day, integer, intent(in), optional hour, integer, intent(in), optional minute, integer, intent(in), optional second, integer, intent(in), optional millisecond, real(kind=real64), intent(in), optional tz )

private

Definition at line 560 of file suews_util_datetime.f95.

 
      !! Constructor function for the `datetime` class.
 
      INTEGER, INTENT(in), OPTIONAL :: year !! year
      INTEGER, INTENT(in), OPTIONAL :: month !! month
      INTEGER, INTENT(in), OPTIONAL :: day !! day
      INTEGER, INTENT(in), OPTIONAL :: hour !! hour
      INTEGER, INTENT(in), OPTIONAL :: minute !! minute
      INTEGER, INTENT(in), OPTIONAL :: second !! second
      INTEGER, INTENT(in), OPTIONAL :: millisecond !! millisecond
      REAL(kind=real64), INTENT(in), OPTIONAL :: tz !! timezone offset in hours
 
      IF (PRESENT(year)) THEN
         datetime_constructor%year = year
      ELSE
         datetime_constructor%year = 1
      END IF
 
      IF (PRESENT(month)) THEN
         datetime_constructor%month = month
      ELSE
         datetime_constructor%month = 1
      END IF
 
      IF (PRESENT(day)) THEN
         datetime_constructor%day = day
      ELSE
         datetime_constructor%day = 1
      END IF
 
      IF (PRESENT(hour)) THEN
         datetime_constructor%hour = hour
      ELSE
         datetime_constructor%hour = 0
      END IF
 
      IF (PRESENT(minute)) THEN
         datetime_constructor%minute = minute
      ELSE
         datetime_constructor%minute = 0
      END IF
 
      IF (PRESENT(second)) THEN
         datetime_constructor%second = second
      ELSE
         datetime_constructor%second = 0
      END IF
 
      IF (PRESENT(millisecond)) THEN
         datetime_constructor%millisecond = millisecond
      ELSE
         datetime_constructor%millisecond = 0
      END IF
 
      IF (PRESENT(tz)) THEN
         datetime_constructor%tz = tz
      ELSE
         datetime_constructor%tz = 0
      END IF
 

Referenced by mod_datetime::datetime::datetime_constructor(), and mod_datetime::datetime::operator().

Here is the caller graph for this function:

datetime_minus_datetime()

pure elemental type(timedelta) function mod_datetime::datetime_minus_datetime ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1233 of file suews_util_datetime.f95.

 
      !! Subtracts a `datetime` instance from another `datetime` instance,
      !! and returns a `timedelta` instance. Overloads the operator `-`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
      TYPE(timedelta) :: t
 
      REAL(kind=real64) :: daysdiff
      INTEGER :: days, hours, minutes, seconds, milliseconds
      INTEGER :: sign_
 
      daysdiff = date2num(d0) - date2num(d1)
 
      IF (daysdiff < 0) THEN
         sign_ = -1
         daysdiff = abs(daysdiff)
      ELSE
         sign_ = 1
      END IF
 
      days = int(daysdiff)
      hours = int((daysdiff - days)*d2h)
      minutes = int((daysdiff - days - hours*h2d)*d2m)
      seconds = int((daysdiff - days - hours*h2d - minutes*m2d)*d2s)
      milliseconds = nint((daysdiff - days - hours*h2d - minutes*m2d &
                           - seconds*s2d)*d2s*1e3_real64)
 
      t = timedelta(sign_*days, sign_*hours, sign_*minutes, sign_*seconds, &
                    sign_*milliseconds)
 

References date2num().

Referenced by mod_datetime::datetime::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

datetime_minus_timedelta()

pure elemental type(datetime) function mod_datetime::datetime_minus_timedelta ( class(datetime), intent(in) d0, class(timedelta), intent(in) t )

private

Definition at line 1220 of file suews_util_datetime.f95.

 
      !! Subtracts a `timedelta` instance from a `datetime` instance and
      !! returns a new `datetime` instance. Overloads the operator `-`.
 
      CLASS(datetime), INTENT(in) :: d0 !! `datetime` instance
      CLASS(timedelta), INTENT(in) :: t !! `timedelta` instance
      TYPE(datetime) :: d
 
      d = d0 + (-t)
 

Referenced by mod_datetime::datetime::operator().

Here is the caller graph for this function:

datetime_plus_timedelta()

pure elemental type(datetime) function mod_datetime::datetime_plus_timedelta ( class(datetime), intent(in) d0, class(timedelta), intent(in) t )

private

Definition at line 1173 of file suews_util_datetime.f95.

 
      !! Adds a `timedelta` instance to a `datetime` instance, and returns a
      !! new `datetime` instance. Overloads the operator `+`.
 
      CLASS(datetime), INTENT(in) :: d0 !! `datetime` instance
      CLASS(timedelta), INTENT(in) :: t !! `timedelta` instance
      TYPE(datetime) :: d
 
      INTEGER :: milliseconds, seconds, minutes, hours, days
 
      d = datetime(year=d0%getYear(), &
                   month=d0%getMonth(), &
                   day=d0%getDay(), &
                   hour=d0%getHour(), &
                   minute=d0%getMinute(), &
                   second=d0%getSecond(), &
                   millisecond=d0%getMillisecond(), &
                   tz=d0%getTz())
 
      milliseconds = t%getMilliseconds()
      seconds = t%getSeconds()
      minutes = t%getMinutes()
      hours = t%getHours()
      days = t%getDays()
 
      IF (milliseconds /= 0) CALL d%addMilliseconds(milliseconds)
      IF (seconds /= 0) CALL d%addSeconds(seconds)
      IF (minutes /= 0) CALL d%addMinutes(minutes)
      IF (hours /= 0) CALL d%addHours(hours)
      IF (days /= 0) CALL d%addDays(days)
 

Referenced by mod_datetime::datetime::operator().

Here is the caller graph for this function:

datetimerange()

pure type(datetime) function, dimension(:), allocatable, public mod_datetime::datetimerange	(	type(datetime), intent(in)	d0,
		type(datetime), intent(in)	d1,
		type(timedelta), intent(in)	t )

Definition at line 1428 of file suews_util_datetime.f95.

 
      !! Given start and end `datetime` instances `d0` and `d1` and time
      !! increment as `timedelta` instance `t`, returns an array of
      !! `datetime` instances. The number of elements is the number of whole
      !! time increments contained between datetimes `d0` and `d1`.
 
      TYPE(datetime), INTENT(in) :: d0 !! start time
      TYPE(datetime), INTENT(in) :: d1 !! end time
      TYPE(timedelta), INTENT(in) :: t !! time increment
 
      REAL(kind=real64) :: datenum0, datenum1, increment
      REAL(kind=real64) :: eps
 
      TYPE(datetime), DIMENSION(:), ALLOCATABLE :: datetimeRange
 
      INTEGER :: n, nm
 
      eps = 1e-10_real64
 
      datenum0 = date2num(d0)
      datenum1 = date2num(d1)
 
      increment = t%total_seconds()*s2d
 
      nm = floor((datenum1 - datenum0 + eps)/increment) + 1
 
      ALLOCATE (datetimerange(nm))
 
      DO n = 1, nm
         datetimerange(n) = num2date(datenum0 + (n - 1)*increment)
      END DO
 

References date2num(), datetimerange(), and num2date().

Referenced by datetimerange().

Here is the call graph for this function:

Here is the caller graph for this function:

daysinmonth()

pure elemental integer function, public mod_datetime::daysinmonth	(	integer, intent(in)	month,
		integer, intent(in)	year )

Definition at line 1463 of file suews_util_datetime.f95.

 
      !! Given integer month and year, returns an integer number
      !! of days in that particular month.
 
      INTEGER, INTENT(in) :: month !! month
      INTEGER, INTENT(in) :: year !! year
 
      INTEGER, PARAMETER, DIMENSION(12) :: &
         days = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 
      IF (month < 1 .OR. month > 12) THEN
         ! Should raise an error and abort here, however we want to keep
         ! the pure and elemental attributes. Make sure this function is
         ! called with the month argument in range.
         daysinmonth = 0
         RETURN
      END IF
 
      IF (month == 2 .AND. isleapyear(year)) THEN
         daysinmonth = 29
      ELSE
         daysinmonth = days(month)
      END IF
 

References daysinmonth(), and isleapyear().

Referenced by adddays(), daysinmonth(), isvalid(), num2date(), and yearday().

Here is the call graph for this function:

Here is the caller graph for this function:

daysinyear()

pure elemental integer function, public mod_datetime::daysinyear

(

integer, intent(in)

year

)

Definition at line 1490 of file suews_util_datetime.f95.

 
      !! Returns the number of days in year.
 
      INTEGER, INTENT(in) :: year !! year
 
      IF (isleapyear(year)) THEN
         daysinyear = 366
      ELSE
         daysinyear = 365
      END IF
 

References daysinyear(), and isleapyear().

Referenced by date2num(), daysinyear(), and num2date().

Here is the call graph for this function:

Here is the caller graph for this function:

eq()

pure elemental logical function mod_datetime::eq ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1352 of file suews_util_datetime.f95.

 
      !! `datetime` comparison operator that returns `.true.` if `d0` is
      !! equal to `d1` and `.false.` otherwise. Overloads the operator `==`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
 
      TYPE(datetime) :: d0_utc, d1_utc
 
      ! Convert to UTC before making comparison
      d0_utc = d0%utc()
      d1_utc = d1%utc()
 
      eq = d0_utc%year == d1_utc%year .AND. &
           d0_utc%month == d1_utc%month .AND. &
           d0_utc%day == d1_utc%day .AND. &
           d0_utc%hour == d1_utc%hour .AND. &
           d0_utc%minute == d1_utc%minute .AND. &
           d0_utc%second == d1_utc%second .AND. &
           d0_utc%millisecond == d1_utc%millisecond
 

References eq().

Referenced by eq().

Here is the call graph for this function:

Here is the caller graph for this function:

ge()

pure elemental logical function mod_datetime::ge ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1388 of file suews_util_datetime.f95.

 
      !! `datetime` comparison operator. Returns `.true.` if `d0` is greater
      !! than or equal to `d1` and `.false.` otherwise. Overloads the
      !! operator `>=`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
 
      ge = d0 > d1 .OR. d0 == d1
 

References ge().

Referenced by ge().

Here is the call graph for this function:

Here is the caller graph for this function:

getday()

pure elemental integer function mod_datetime::getday ( class(datetime), intent(in) self )

private

Definition at line 639 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      getday = self%day

References getday().

Referenced by getday().

Here is the call graph for this function:

Here is the caller graph for this function:

gethour()

pure elemental integer function mod_datetime::gethour ( class(datetime), intent(in) self )

private

Definition at line 645 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      gethour = self%hour

References gethour().

Referenced by gethour().

Here is the call graph for this function:

Here is the caller graph for this function:

getmillisecond()

pure elemental integer function mod_datetime::getmillisecond ( class(datetime), intent(in) self )

private

Definition at line 663 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      getmillisecond = self%millisecond

References getmillisecond().

Referenced by getmillisecond().

Here is the call graph for this function:

Here is the caller graph for this function:

getminute()

pure elemental integer function mod_datetime::getminute ( class(datetime), intent(in) self )

private

Definition at line 651 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      getminute = self%minute

References getminute().

Referenced by getminute().

Here is the call graph for this function:

Here is the caller graph for this function:

getmonth()

pure elemental integer function mod_datetime::getmonth ( class(datetime), intent(in) self )

private

Definition at line 633 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      getmonth = self%month

References getmonth().

Referenced by getmonth().

Here is the call graph for this function:

Here is the caller graph for this function:

getsecond()

pure elemental integer function mod_datetime::getsecond ( class(datetime), intent(in) self )

private

Definition at line 657 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      getsecond = self%second

References getsecond().

Referenced by getsecond().

Here is the call graph for this function:

Here is the caller graph for this function:

gettz()

pure elemental real(kind=real64) function mod_datetime::gettz ( class(datetime), intent(in) self )

private

Definition at line 669 of file suews_util_datetime.f95.

      !! Returns the timezone offset component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      gettz = self%tz

References gettz().

Referenced by gettz().

Here is the call graph for this function:

Here is the caller graph for this function:

getyear()

pure elemental integer function mod_datetime::getyear ( class(datetime), intent(in) self )

private

Definition at line 627 of file suews_util_datetime.f95.

      !! Returns the year component
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      getyear = self%year

References getyear().

Referenced by getyear().

Here is the call graph for this function:

Here is the caller graph for this function:

gt()

pure elemental logical function mod_datetime::gt ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1267 of file suews_util_datetime.f95.

 
      !! `datetime` comparison operator that eturns `.true.` if `d0` is
      !! greater than `d1` and `.false.` otherwise. Overloads the
      !! operator `>`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
 
      TYPE(datetime) :: d0_utc, d1_utc
 
      ! Convert to UTC before making comparison
      d0_utc = d0%utc()
      d1_utc = d1%utc()
 
      ! Year comparison block
      IF (d0_utc%year > d1_utc%year) THEN
         gt = .true.
      ELSEIF (d0_utc%year < d1_utc%year) THEN
         gt = .false.
      ELSE
 
         ! Month comparison block
         IF (d0_utc%month > d1_utc%month) THEN
            gt = .true.
         ELSEIF (d0_utc%month < d1_utc%month) THEN
            gt = .false.
         ELSE
 
            ! Day comparison block
            IF (d0_utc%day > d1_utc%day) THEN
               gt = .true.
            ELSEIF (d0_utc%day < d1_utc%day) THEN
               gt = .false.
            ELSE
 
               ! Hour comparison block
               IF (d0_utc%hour > d1_utc%hour) THEN
                  gt = .true.
               ELSEIF (d0_utc%hour < d1_utc%hour) THEN
                  gt = .false.
               ELSE
 
                  ! Minute comparison block
                  IF (d0_utc%minute > d1_utc%minute) THEN
                     gt = .true.
                  ELSEIF (d0_utc%minute < d1_utc%minute) THEN
                     gt = .false.
                  ELSE
 
                     ! Second comparison block
                     IF (d0_utc%second > d1_utc%second) THEN
                        gt = .true.
                     ELSEIF (d0_utc%second < d1_utc%second) THEN
                        gt = .false.
                     ELSE
 
                        ! Millisecond comparison block
                        IF (d0_utc%millisecond > d1_utc%millisecond) THEN
                           gt = .true.
                        ELSE
                           gt = .false.
                        END IF
 
                     END IF
                  END IF
               END IF
            END IF
         END IF
      END IF
 

References gt().

Referenced by gt().

Here is the call graph for this function:

Here is the caller graph for this function:

int2str()

pure character(len=length) function mod_datetime::int2str ( integer, intent(in) i, integer, intent(in) length )

private

Definition at line 1636 of file suews_util_datetime.f95.

 
      !! Converts an integer `i` into a character string of requested length,
      !! pre-pending zeros if necessary.
 
      INTEGER, INTENT(in) :: i !! integer to convert to string
      INTEGER, INTENT(in) :: length !! desired length of string
 
      CHARACTER(len=length) :: int2str
      CHARACTER(len=2) :: string
 
      WRITE (unit=string, fmt='(I2)') length
      WRITE (unit=int2str, fmt='(I'//string//'.'//string//')') i
 

References int2str().

Referenced by int2str(), and isoformat().

Here is the call graph for this function:

Here is the caller graph for this function:

isleapyear()

pure elemental logical function, public mod_datetime::isleapyear

(

integer, intent(in)

year

)

Definition at line 1417 of file suews_util_datetime.f95.

 
      !! Returns `.true.` if year is leap year and `.false.` otherwise.
 
      INTEGER, INTENT(in) :: year !! year
 
      isleapyear = (mod(year, 4) == 0 .AND. .NOT. mod(year, 100) == 0) &
                   .OR. (mod(year, 400) == 0)
 

References isleapyear().

Referenced by daysinmonth(), daysinyear(), and isleapyear().

Here is the call graph for this function:

Here is the caller graph for this function:

isocalendar()

integer function, dimension(3) mod_datetime::isocalendar ( class(datetime), intent(in) self )

private

Definition at line 1031 of file suews_util_datetime.f95.

 
      !! Returns an array of 3 integers, year, week number, and week day,
      !! as defined by ISO 8601 week date. Essentially a wrapper around C
      !! `strftime` function.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      INTEGER, DIMENSION(3) :: isocalendar
      INTEGER :: year, week, wday
      INTEGER :: rc
      CHARACTER(len=20) :: string
 
      rc = c_strftime(string, len(string), '%G %V %u'//c_null_char, &
                      self%tm())
 
      READ (unit=string(1:4), fmt='(I4)') year
      READ (unit=string(6:7), fmt='(I2)') week
      READ (unit=string(9:9), fmt='(I1)') wday
 
      isocalendar = [year, week, wday]
 

References isocalendar().

Referenced by isocalendar().

Here is the call graph for this function:

Here is the caller graph for this function:

isoformat()

pure elemental character(len=23) function mod_datetime::isoformat ( class(datetime), intent(in) self, character(len=1), intent(in), optional sep )

private

Definition at line 808 of file suews_util_datetime.f95.

 
      !! Returns character string with time in ISO 8601 format.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime instance`
      CHARACTER(len=1), INTENT(in), OPTIONAL :: sep
      !! separator character, 'T' is default
 
      CHARACTER(len=1) :: separator
 
      IF (PRESENT(sep)) THEN
         separator = sep
      ELSE
         separator = 'T'
      END IF
 
      ! TODO below is a bit cumbersome and was implemented
      ! at a time before the interface to strftime. Now we
      ! could do something like:
      !
      ! isoformat = self % strftime('%Y-%m-%d'//separator//'%H:%M:%S')
      !
      isoformat = int2str(self%year, 4)//'-'// &
                  int2str(self%month, 2)//'-'// &
                  int2str(self%day, 2)//separator// &
                  int2str(self%hour, 2)//':'// &
                  int2str(self%minute, 2)//':'// &
                  int2str(self%second, 2)//'.'// &
                  int2str(self%millisecond, 3)
 

References int2str(), and isoformat().

Referenced by isoformat().

Here is the call graph for this function:

Here is the caller graph for this function:

isoweekday()

pure elemental integer function mod_datetime::isoweekday ( class(datetime), intent(in) self )

private

Definition at line 952 of file suews_util_datetime.f95.

 
      !! Returns the day of the week per ISO 8601 returned from weekday().
      !! Returned value is an integer scalar in the range [1-7], such that:
      !!
      !! 1: Monday
      !! 2: Tuesday
      !! 3: Wednesday
      !! 4: Thursday
      !! 5: Friday
      !! 6: Saturday
      !! 7: Sunday
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      isoweekday = self%weekday()
 
      IF (isoweekday == 0) THEN
         isoweekday = 7
      END IF
 

References isoweekday().

Referenced by isoweekday().

Here is the call graph for this function:

Here is the caller graph for this function:

isoweekdaylong()

pure elemental character(len=9) function mod_datetime::isoweekdaylong ( class(datetime), intent(in) self )

private

Definition at line 989 of file suews_util_datetime.f95.

 
      !! Returns the full name of the day of the week for ISO 8601
      !! ordered weekdays.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      CHARACTER(len=9), PARAMETER, DIMENSION(7) :: &
         days = ['Monday   ', 'Tuesday  ', 'Wednesday', 'Thursday ', &
                 'Friday   ', 'Saturday ', 'Sunday   ']
 
      isoweekdaylong = days(self%isoweekday())
 

References isoweekdaylong().

Referenced by isoweekdaylong().

Here is the call graph for this function:

Here is the caller graph for this function:

isoweekdayshort()

pure elemental character(len=3) function mod_datetime::isoweekdayshort ( class(datetime), intent(in) self )

private

Definition at line 1017 of file suews_util_datetime.f95.

 
      !! Returns the short (3-letter) name of the day of the week
      !! based on ISO 8601 ordering.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      CHARACTER(len=3), PARAMETER, DIMENSION(7) :: &
         days = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
 
      isoweekdayshort = days(self%isoweekday())
 

References isoweekdayshort().

Referenced by isoweekdayshort().

Here is the call graph for this function:

Here is the caller graph for this function:

isvalid()

pure elemental logical function mod_datetime::isvalid ( class(datetime), intent(in) self )

private

Definition at line 840 of file suews_util_datetime.f95.

 
      !! Checks whether the `datetime` instance has valid component values.
      !! Returns `.true.` if the `datetime` instance is valid, and `.false.`
      !! otherwise.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      ! assume valid
      isvalid = .true.
 
      IF (self%year < 1) THEN
         isvalid = .false.
         RETURN
      END IF
 
      IF (self%month < 1 .OR. self%month > 12) THEN
         isvalid = .false.
         RETURN
      END IF
 
      IF (self%day < 1 .OR. &
          self%day > daysinmonth(self%month, self%year)) THEN
         isvalid = .false.
         RETURN
      END IF
 
      IF (self%hour < 0 .OR. self%hour > 23) THEN
         isvalid = .false.
         RETURN
      END IF
 
      IF (self%minute < 0 .OR. self%minute > 59) THEN
         isvalid = .false.
         RETURN
      END IF
 
      IF (self%second < 0 .OR. self%second > 59) THEN
         isvalid = .false.
         RETURN
      END IF
 
      IF (self%millisecond < 0 .OR. self%millisecond > 999) THEN
         isvalid = .false.
         RETURN
      END IF
 

References daysinmonth(), and isvalid().

Referenced by isvalid().

Here is the call graph for this function:

Here is the caller graph for this function:

le()

pure elemental logical function mod_datetime::le ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1401 of file suews_util_datetime.f95.

 
      !! `datetime` comparison operator. Returns `.true.` if `d0` is less
      !! than or equal to `d1`, and `.false.` otherwise. Overloads the
      !! operator `<=`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
 
      le = d1 > d0 .OR. d0 == d1
 

References le().

Referenced by le().

Here is the call graph for this function:

Here is the caller graph for this function:

lt()

pure elemental logical function mod_datetime::lt ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1340 of file suews_util_datetime.f95.

 
      !! `datetime` comparison operator that returns `.true.` if `d0` is
      !! less than `d1` and `.false.` otherwise. Overloads the operator `<`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
 
      lt = d1 > d0
 

References lt().

Referenced by lt().

Here is the call graph for this function:

Here is the caller graph for this function:

neq()

pure elemental logical function mod_datetime::neq ( class(datetime), intent(in) d0, class(datetime), intent(in) d1 )

private

Definition at line 1376 of file suews_util_datetime.f95.

 
      !! `datetime` comparison operator that eturns `.true.` if `d0` is
      !! not equal to `d1` and `.false.` otherwise. Overloads the operator `/=`.
 
      CLASS(datetime), INTENT(in) :: d0 !! lhs `datetime` instance
      CLASS(datetime), INTENT(in) :: d1 !! rhs `datetime` instance
 
      neq = .NOT. d0 == d1
 

References neq().

Referenced by neq().

Here is the call graph for this function:

Here is the caller graph for this function:

now()

type(datetime) function mod_datetime::now

private

Definition at line 889 of file suews_util_datetime.f95.

 
      !! Returns a `datetime` instance with current time.
      !! No input arguments.
 
      CHARACTER(len=5) :: zone
      INTEGER, DIMENSION(8) :: values
 
      INTEGER :: hour, minute
 
      ! Obtain local machine time zone information
      CALL date_and_time(zone=zone, values=values)
 
      READ (unit=zone(1:3), fmt='(I3)') hour
      READ (unit=zone(4:5), fmt='(I2)') minute
 
      now = datetime(year=values(1), &
                     month=values(2), &
                     day=values(3), &
                     hour=values(5), &
                     minute=values(6), &
                     second=values(7), &
                     millisecond=values(8))
 
      now%tz = hour + minute*m2h
 

References now().

Referenced by now().

Here is the call graph for this function:

Here is the caller graph for this function:

num2date()

pure elemental type(datetime) function, public mod_datetime::num2date

(

real(kind=real64), intent(in)

num

)

Definition at line 1536 of file suews_util_datetime.f95.

 
      !! Given number of days since `0001-01-01 00:00:00`, returns a
      !! correspoding `datetime` instance.
 
      REAL(kind=real64), INTENT(in) :: num
      !! number of days since `0001-01-01 00:00:00`
 
      INTEGER :: year, month, day, hour, minute, second, millisecond
      REAL(kind=real64) :: days, totseconds
 
      ! num must be positive:
      IF (num < 0) THEN
         num2date = datetime(1)
         RETURN
      END IF
 
      days = num
 
      year = 1
      DO
         IF (int(days) <= daysinyear(year)) EXIT
         days = days - daysinyear(year)
         year = year + 1
      END DO
 
      month = 1
      DO
         IF (int(days) <= daysinmonth(month, year)) EXIT
         days = days - daysinmonth(month, year)
         month = month + 1
      END DO
 
      day = int(days)
      totseconds = (days - day)*d2s
      hour = int(totseconds*s2h)
      minute = int((totseconds - hour*h2s)*s2m)
      second = int(totseconds - hour*h2s - minute*m2s)
      millisecond = nint((totseconds - int(totseconds))*1e3_real64)
 
      num2date = datetime(year, month, day, hour, minute, second, millisecond, tz=zero)
 
      ! Handle a special case caused by floating-point arithmethic:
      IF (num2date%millisecond == 1000) THEN
         num2date%millisecond = 0
         CALL num2date%addSeconds(1)
      END IF
 
      IF (num2date%second == 60) THEN
         num2date%second = 0
         CALL num2date%addMinutes(1)
      END IF
      IF (num2date%minute == 60) THEN
         num2date%minute = 0
         CALL num2date%addHours(1)
      END IF
      IF (num2date%hour == 60) THEN
         num2date%hour = 0
         CALL num2date%addDays(1)
      END IF
 

References daysinmonth(), daysinyear(), and num2date().

Referenced by datetimerange(), and num2date().

Here is the call graph for this function:

Here is the caller graph for this function:

secondssinceepoch()

integer function mod_datetime::secondssinceepoch ( class(datetime), intent(in) self )

private

Definition at line 1055 of file suews_util_datetime.f95.

 
      !! Returns an integer number of seconds since the UNIX Epoch,
      !! `1970-01-01 00:00:00`. Note that this is a wrapper around C's
      !! `strftime('%s')`, so the number of seconds will reflect the time
      !! zone of the local machine on which the function is being called.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      CHARACTER(len=11) :: string
 
      string = self%strftime('%s')
      READ (unit=string, fmt='(I10)') secondssinceepoch
 

References secondssinceepoch().

Referenced by secondssinceepoch().

Here is the call graph for this function:

Here is the caller graph for this function:

strftime()

character(len=:) function, allocatable mod_datetime::strftime ( class(datetime), intent(in) self, character(len=*), intent(in) format )

private

Definition at line 1071 of file suews_util_datetime.f95.

 
      !! Wrapper around C/C++ `strftime` function.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
      CHARACTER(len=*), INTENT(in) :: FORMAT !! format string
 
      CHARACTER(len=:), ALLOCATABLE :: strftime
 
      INTEGER :: n, rc
      CHARACTER(len=MAXSTRLEN) :: resultString
 
      resultstring = ""
      rc = c_strftime(resultstring, maxstrlen, trim(format)//c_null_char, &
                      self%tm())
      strftime = trim(resultstring)
      n = len(strftime)
      strftime = strftime(1:n - 1)
 

References strftime().

Referenced by strftime().

Here is the call graph for this function:

Here is the caller graph for this function:

strptime()

type(datetime) function, public mod_datetime::strptime	(	character(len=*), intent(in)	str,
		character(len=*), intent(in)	format )

Definition at line 1599 of file suews_util_datetime.f95.

 
      !! A wrapper function around C/C++ strptime function.
      !! Returns a `datetime` instance.
 
      CHARACTER(len=*), INTENT(in) :: str !! time string
      CHARACTER(len=*), INTENT(in) :: FORMAT !! time format
 
      INTEGER :: rc
      TYPE(tm_struct) :: tm
 
      rc = c_strptime(trim(str)//c_null_char, trim(format)//c_null_char, tm)
      strptime = tm2date(tm)
 

References strptime(), tm(), and tm2date().

Referenced by strptime().

Here is the call graph for this function:

Here is the caller graph for this function:

timedelta_plus_datetime()

pure elemental type(datetime) function mod_datetime::timedelta_plus_datetime ( class(timedelta), intent(in) t, class(datetime), intent(in) d0 )

private

Definition at line 1207 of file suews_util_datetime.f95.

 
      !! Adds a `timedelta` instance to a `datetime` instance, and returns a
      !! new `datetime` instance. Overloads the operator `+`.
 
      CLASS(timedelta), INTENT(in) :: t !! `timedelta` instance
      CLASS(datetime), INTENT(in) :: d0 !! `datetime` instance
      TYPE(datetime) :: d
 
      d = d0 + t
 

Referenced by mod_datetime::datetime::operator().

Here is the caller graph for this function:

tm()

pure elemental type(tm_struct) function mod_datetime::tm ( class(datetime), intent(in) self )

private

Definition at line 1092 of file suews_util_datetime.f95.

 
      !! Returns a `tm_struct` instance of the current `datetime`.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      tm%tm_sec = self%second
      tm%tm_min = self%minute
      tm%tm_hour = self%hour
      tm%tm_mday = self%day
      tm%tm_mon = self%month - 1
      tm%tm_year = self%year - 1900
      tm%tm_wday = self%weekday()
      tm%tm_yday = self%yearday() - 1
      tm%tm_isdst = -1
 

References tm().

Referenced by strptime(), and tm().

Here is the call graph for this function:

Here is the caller graph for this function:

tm2date()

pure elemental type(datetime) function, public mod_datetime::tm2date

(

type(tm_struct), intent(in)

ctime

)

Definition at line 1615 of file suews_util_datetime.f95.

 
      !! Given a `tm_struct` instance, returns a corresponding `datetime`
      !! instance.
 
      TYPE(tm_struct), INTENT(in) :: ctime !! C-style time struct
 
      tm2date%millisecond = 0
      tm2date%second = ctime%tm_sec
      tm2date%minute = ctime%tm_min
      tm2date%hour = ctime%tm_hour
      tm2date%day = ctime%tm_mday
      tm2date%month = ctime%tm_mon + 1
      tm2date%year = ctime%tm_year + 1900
      tm2date%tz = 0
 

References tm2date().

Referenced by strptime(), and tm2date().

Here is the call graph for this function:

Here is the caller graph for this function:

tzoffset()

pure elemental character(len=5) function mod_datetime::tzoffset ( class(datetime), intent(in) self )

private

Definition at line 1110 of file suews_util_datetime.f95.

 
      !! Returns a character string with timezone offset in hours from UTC,
      !! in format +/-[hh][mm].
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      INTEGER :: hours, minutes
 
      IF (self%tz < 0) THEN
         tzoffset(1:1) = '-'
      ELSE
         tzoffset(1:1) = '+'
      END IF
 
      hours = int(abs(self%tz))
      minutes = nint((abs(self%tz) - hours)*60)
 
      IF (minutes == 60) THEN
         minutes = 0
         hours = hours + 1
      END IF
 
      WRITE (unit=tzoffset(2:5), fmt='(2I2.2)') hours, minutes
 

References tzoffset().

Referenced by tzoffset().

Here is the call graph for this function:

Here is the caller graph for this function:

utc()

pure elemental type(datetime) function mod_datetime::utc ( class(datetime), intent(in) self )

private

Definition at line 1137 of file suews_util_datetime.f95.

 
      !! Returns the `datetime` instance at Coordinated Universal Time (UTC).
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      INTEGER :: hours, minutes, sgn
 
      hours = int(abs(self%tz))
      minutes = nint((abs(self%tz) - hours)*60)
      sgn = int(sign(one, self%tz))
 
      utc = self - timedelta(hours=sgn*hours, minutes=sgn*minutes)
      utc%tz = 0
 

References utc().

Referenced by utc().

Here is the call graph for this function:

Here is the caller graph for this function:

weekday()

pure elemental integer function mod_datetime::weekday ( class(datetime), intent(in) self )

private

Definition at line 917 of file suews_util_datetime.f95.

 
      !! Returns the day of the week calculated using Zeller's congruence.
      !! Returned value is an integer scalar in the range [0-6], such that:
      !!
      !! 0: Sunday
      !! 1: Monday
      !! 2: Tuesday
      !! 3: Wednesday
      !! 4: Thursday
      !! 5: Friday
      !! 6: Saturday
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      INTEGER :: year, month
      INTEGER :: j, k
 
      year = self%year
      month = self%month
 
      IF (month <= 2) THEN
         month = month + 12
         year = year - 1
      END IF
 
      j = year/100
      k = mod(year, 100)
 
      weekday = mod(self%day + ((month + 1)*26)/10 + k + k/4 + j/4 + 5*j, 7) - 1
 
      IF (weekday < 0) weekday = 6
 

References weekday().

Referenced by weekday().

Here is the call graph for this function:

Here is the caller graph for this function:

weekdaylong()

pure elemental character(len=9) function mod_datetime::weekdaylong ( class(datetime), intent(in) self )

private

Definition at line 975 of file suews_util_datetime.f95.

 
      !! Returns the full name of the day of the week.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      CHARACTER(len=9), PARAMETER, DIMENSION(7) :: &
         days = ['Sunday   ', 'Monday   ', 'Tuesday  ', 'Wednesday', &
                 'Thursday ', 'Friday   ', 'Saturday ']
 
      weekdaylong = days(self%weekday() + 1)
 

References weekdaylong().

Referenced by weekdaylong().

Here is the call graph for this function:

Here is the caller graph for this function:

weekdayshort()

pure elemental character(len=3) function mod_datetime::weekdayshort ( class(datetime), intent(in) self )

private

Definition at line 1004 of file suews_util_datetime.f95.

 
      !! Returns the short (3-letter) name of the day of the week.
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      CHARACTER(len=3), PARAMETER, DIMENSION(7) :: &
         days = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']
 
      weekdayshort = days(self%weekday() + 1)
 

References weekdayshort().

Referenced by weekdayshort().

Here is the call graph for this function:

Here is the caller graph for this function:

yearday()

pure elemental integer function mod_datetime::yearday ( class(datetime), intent(in) self )

private

Definition at line 1154 of file suews_util_datetime.f95.

 
      !! Returns the integer day of the year (ordinal date).
 
      CLASS(datetime), INTENT(in) :: self !! `datetime` instance
 
      INTEGER :: month
 
      yearday = 0
      DO month = 1, self%month - 1
         yearday = yearday + daysinmonth(month, self%year)
      END DO
      yearday = yearday + self%day
 

References daysinmonth(), and yearday().

Referenced by yearday().

Here is the call graph for this function:

Here is the caller graph for this function: