mod_timedelta Module Reference

Data Types
interface	timedelta

Functions/Subroutines
pure elemental type(timedelta) function	timedelta_constructor (days, hours, minutes, seconds, milliseconds)
pure elemental integer function	getdays (self)
pure elemental integer function	gethours (self)
pure elemental integer function	getminutes (self)
pure elemental integer function	getseconds (self)
pure elemental integer function	getmilliseconds (self)
pure elemental real(kind=real64) function	total_seconds (self)
pure elemental type(timedelta) function	timedelta_plus_timedelta (t0, t1)
pure elemental type(timedelta) function	timedelta_minus_timedelta (t0, t1)
pure elemental type(timedelta) function	unary_minus_timedelta (t0)
pure elemental logical function	eq (td0, td1)
pure elemental logical function	neq (td0, td1)
pure elemental logical function	gt (td0, td1)
pure elemental logical function	ge (td0, td1)
pure elemental logical function	lt (td0, td1)
pure elemental logical function	le (td0, td1)

Function/Subroutine Documentation

eq()

pure elemental logical function mod_timedelta::eq ( class(timedelta), intent(in) td0, type(timedelta), intent(in) td1 )

private

Definition at line 358 of file suews_util_datetime.f95.

 
      !! `timedelta` object comparison operator. Returns `.true.` if `td0`
      !! is equal to `td1` and `.false.` otherwise. Overloads the operator
      !! `==`.
 
      CLASS(timedelta), INTENT(in) :: td0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: td1 !! rhs `timedelta` instance
 
      eq = td0%total_seconds() == td1%total_seconds()
 

References eq().

Referenced by eq(), mod_datetime::datetime::operator(), and mod_timedelta::timedelta::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

ge()

pure elemental logical function mod_timedelta::ge ( class(timedelta), intent(in) td0, type(timedelta), intent(in) td1 )

private

Definition at line 397 of file suews_util_datetime.f95.

 
      !! `timedelta` object comparison operator. Returns `.true.` if `td0`
      !! is greater than or equal to `td1` and `.false.` otherwise.
      !! Overloads the operator >=.
 
      CLASS(timedelta), INTENT(in) :: td0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: td1 !! rhs `timedelta` instance
 
      ge = td0%total_seconds() >= td1%total_seconds()
 

References ge().

Referenced by ge(), mod_datetime::datetime::operator(), and mod_timedelta::timedelta::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

getdays()

pure elemental integer function mod_timedelta::getdays ( class(timedelta), intent(in) self )

private

Definition at line 267 of file suews_util_datetime.f95.

      !! Returns the number of days.
      CLASS(timedelta), INTENT(in) :: self !! `timedelta` instance
      getdays = self%days

References getdays().

Referenced by getdays().

Here is the call graph for this function:

Here is the caller graph for this function:

gethours()

pure elemental integer function mod_timedelta::gethours ( class(timedelta), intent(in) self )

private

Definition at line 273 of file suews_util_datetime.f95.

      !! Returns the number of hours.
      CLASS(timedelta), INTENT(in) :: self !! `timedelta` instance
      gethours = self%hours

References gethours().

Referenced by gethours().

Here is the call graph for this function:

Here is the caller graph for this function:

getmilliseconds()

pure elemental integer function mod_timedelta::getmilliseconds ( class(timedelta), intent(in) self )

private

Definition at line 291 of file suews_util_datetime.f95.

      !! Returns the number of milliseconds.
      CLASS(timedelta), INTENT(in) :: self !! `timedelta` instance
      getmilliseconds = self%milliseconds

References getmilliseconds().

Referenced by getmilliseconds().

Here is the call graph for this function:

Here is the caller graph for this function:

getminutes()

pure elemental integer function mod_timedelta::getminutes ( class(timedelta), intent(in) self )

private

Definition at line 279 of file suews_util_datetime.f95.

      !! Returns the number of minutes.
      CLASS(timedelta), INTENT(in) :: self !! `timedelta` instance
      getminutes = self%minutes

References getminutes().

Referenced by getminutes().

Here is the call graph for this function:

Here is the caller graph for this function:

getseconds()

pure elemental integer function mod_timedelta::getseconds ( class(timedelta), intent(in) self )

private

Definition at line 285 of file suews_util_datetime.f95.

      !! Returns the number of seconds.
      CLASS(timedelta), INTENT(in) :: self !! `timedelta` instance
      getseconds = self%seconds

References getseconds().

Referenced by getseconds().

Here is the call graph for this function:

Here is the caller graph for this function:

gt()

pure elemental logical function mod_timedelta::gt ( class(timedelta), intent(in) td0, type(timedelta), intent(in) td1 )

private

Definition at line 384 of file suews_util_datetime.f95.

 
      !! `timedelta` object comparison operator. Returns `.true.` if
      !! `td0` is greater than `td1` and `.false.` otherwise. Overloads the
      !! operator `>`.
 
      CLASS(timedelta), INTENT(in) :: td0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: td1 !! rhs `timedelta` instance
 
      gt = td0%total_seconds() > td1%total_seconds()
 

References gt().

Referenced by gt(), mod_datetime::datetime::operator(), and mod_timedelta::timedelta::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

le()

pure elemental logical function mod_timedelta::le ( class(timedelta), intent(in) td0, type(timedelta), intent(in) td1 )

private

Definition at line 423 of file suews_util_datetime.f95.

 
      !! `timedelta` object comparison operator. Returns `.true.` if `td0`
      !! is less than or equal to `td1` and `.false.` otherwise. Overloads
      !! the operator `<=`.
 
      CLASS(timedelta), INTENT(in) :: td0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: td1 !! rhs `timedelta` instance
 
      le = td0%total_seconds() <= td1%total_seconds()
 

References le().

Referenced by le(), mod_datetime::datetime::operator(), and mod_timedelta::timedelta::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

lt()

pure elemental logical function mod_timedelta::lt ( class(timedelta), intent(in) td0, type(timedelta), intent(in) td1 )

private

Definition at line 410 of file suews_util_datetime.f95.

 
      !! `timedelta` object comparison operator. Returns `.true.` if `td0`
      !! is less than `td1` and `.false.` otherwise. Overloads the operator
      !! `<`.
 
      CLASS(timedelta), INTENT(in) :: td0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: td1 !! rhs `timedelta` instance
 
      lt = td0%total_seconds() < td1%total_seconds()
 

References lt().

Referenced by lt(), mod_datetime::datetime::operator(), and mod_timedelta::timedelta::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

neq()

pure elemental logical function mod_timedelta::neq ( class(timedelta), intent(in) td0, type(timedelta), intent(in) td1 )

private

Definition at line 371 of file suews_util_datetime.f95.

 
      !! `timedelta` object comparison operator. Returns `.true.` if `td0`
      !! is not equal to `td1` and `.false.` otherwise. Overloads the
      !! operator `/=`.
 
      CLASS(timedelta), INTENT(in) :: td0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: td1 !! rhs `timedelta` instance
 
      neq = .NOT. (td0%total_seconds() == td1%total_seconds())
 

References neq().

Referenced by neq(), mod_datetime::datetime::operator(), and mod_timedelta::timedelta::operator().

Here is the call graph for this function:

Here is the caller graph for this function:

timedelta_constructor()

pure elemental type(timedelta) function mod_timedelta::timedelta_constructor ( integer, intent(in), optional days, integer, intent(in), optional hours, integer, intent(in), optional minutes, integer, intent(in), optional seconds, integer, intent(in), optional milliseconds )

private

Definition at line 221 of file suews_util_datetime.f95.

 
      !! Constructor function for the `timedelta` class.
 
      INTEGER, INTENT(in), OPTIONAL :: days !! number of days
      INTEGER, INTENT(in), OPTIONAL :: hours !! number of hours
      INTEGER, INTENT(in), OPTIONAL :: minutes !! number of minutes
      INTEGER, INTENT(in), OPTIONAL :: seconds !! number of seconds
      INTEGER, INTENT(in), OPTIONAL :: milliseconds !! number of milliseconds
 
      IF (PRESENT(days)) THEN
         timedelta_constructor%days = days
      ELSE
         timedelta_constructor%days = 0
      END IF
 
      IF (PRESENT(hours)) THEN
         timedelta_constructor%hours = hours
      ELSE
         timedelta_constructor%hours = 0
      END IF
 
      IF (PRESENT(minutes)) THEN
         timedelta_constructor%minutes = minutes
      ELSE
         timedelta_constructor%minutes = 0
      END IF
 
      IF (PRESENT(seconds)) THEN
         timedelta_constructor%seconds = seconds
      ELSE
         timedelta_constructor%seconds = 0
      END IF
 
      IF (PRESENT(milliseconds)) THEN
         timedelta_constructor%milliseconds = milliseconds
      ELSE
         timedelta_constructor%milliseconds = 0
      END IF
 

Referenced by mod_timedelta::timedelta::operator(), and mod_timedelta::timedelta::timedelta_constructor().

Here is the caller graph for this function:

timedelta_minus_timedelta()

pure elemental type(timedelta) function mod_timedelta::timedelta_minus_timedelta ( class(timedelta), intent(in) t0, type(timedelta), intent(in) t1 )

private

Definition at line 329 of file suews_util_datetime.f95.

 
      !! Subtracts a `timedelta` instance from another. Returns a
      !! `timedelta` instance. Overloads the operator `-`.
 
      CLASS(timedelta), INTENT(in) :: t0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: t1 !! lhs `timedelta` instance
      TYPE(timedelta) :: t !! result
 
      t = t0 + (-t1)
 

Referenced by mod_timedelta::timedelta::operator().

Here is the caller graph for this function:

timedelta_plus_timedelta()

pure elemental type(timedelta) function mod_timedelta::timedelta_plus_timedelta ( class(timedelta), intent(in) t0, type(timedelta), intent(in) t1 )

private

Definition at line 312 of file suews_util_datetime.f95.

 
      !! Adds two `timedelta` instances together and returns a `timedelta`
      !! instance. Overloads the operator `+`.
 
      CLASS(timedelta), INTENT(in) :: t0 !! lhs `timedelta` instance
      TYPE(timedelta), INTENT(in) :: t1 !! rhs `timedelta` instance
      TYPE(timedelta) :: t !! result
 
      t = timedelta(days=t0%days + t1%days, &
                    hours=t0%hours + t1%hours, &
                    minutes=t0%minutes + t1%minutes, &
                    seconds=t0%seconds + t1%seconds, &
                    milliseconds=t0%milliseconds + t1%milliseconds)
 

Referenced by mod_timedelta::timedelta::operator().

Here is the caller graph for this function:

total_seconds()

pure elemental real(kind=real64) function mod_timedelta::total_seconds ( class(timedelta), intent(in) self )

private

Definition at line 297 of file suews_util_datetime.f95.

 
      !! Returns a total number of seconds contained in a `timedelta`
      !! instance.
 
      CLASS(timedelta), INTENT(in) :: self !! `timedelta` instance
 
      total_seconds = self%days*86400._real64 &
                      + self%hours*3600._real64 &
                      + self%minutes*60._real64 &
                      + self%seconds &
                      + self%milliseconds*1e-3_real64
 

References total_seconds().

Referenced by total_seconds().

Here is the call graph for this function:

Here is the caller graph for this function:

unary_minus_timedelta()

pure elemental type(timedelta) function mod_timedelta::unary_minus_timedelta ( class(timedelta), intent(in) t0 )

private

Definition at line 342 of file suews_util_datetime.f95.

 
      !! Takes a negative of a `timedelta` instance. Overloads the operator
      !! `-`.
 
      CLASS(timedelta), INTENT(in) :: t0 !! `timedelta` instance
      TYPE(timedelta) :: t !! result
 
      t%days = -t0%days
      t%hours = -t0%hours
      t%minutes = -t0%minutes
      t%seconds = -t0%seconds
      t%milliseconds = -t0%milliseconds
 

Referenced by mod_timedelta::timedelta::operator().

Here is the caller graph for this function: