pm_dateTime::dateTimeInt_type Interface Reference

This is the derived type containing the components of a numeric date and time in the Gregorian calendar. More...

Public Member Functions
procedure, pass	getValues => getDateTimeIntValues
type(dateTimeInt_type) function	dateTimeInt_typer ()
	This is the constructor of the dateTimeInt_type class. More...

Public Attributes
integer(IK)	year = 1_IK
	The scalar integer of default kind IK containing the year of the Gregorian calendar. More...
integer(IK)	month = 1_IK
	The scalar integer of default kind IK containing the month of the year. More...
integer(IK)	day = 1_IK
	The scalar integer of default kind IK containing the day of the month. More...
integer(IK)	zone = 0_IK
	The scalar integer of default kind IK containing the time difference in minutes with respect to the UTC. More...
integer(IK)	hour = 0_IK
	The scalar integer of default kind IK containing the hour of the day. More...
integer(IK)	minute = 0_IK
	The scalar integer of default kind IK containing the minute of the hour. More...
integer(IK)	second = 0_IK
	The scalar integer of default kind IK containing the second of the minute. More...
integer(IK)	millisecond = 0_IK
	The scalar integer of default kind IK containing the milliseconds of the second. More...

Detailed Description

This is the derived type containing the components of a numeric date and time in the Gregorian calendar.

This class is a simple container for the values returned by the Fortran intrinsic date_and_time().

Possible calling interfaces ⛓

use pm_dateTime, only: dateTimeInt_type
type(dateTimeInt_type) :: dateTimeInt
 
dateTimeInt = dateTimeInt_type( year = year &
                              , month = month &
                              , day = day &
                              , zone = zone &
                              , hour = hour &
                              , minute = minute &
                              , second = second &
                              , millisecond = millisecond &
                              )

See also

dateTimeInt_typer (class constructor)
dateTimeStr_type

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_io, only: display_type
    use pm_dateTime, only: dateTimeInt_type
 
    implicit none
 
    type(dateTimeInt_type) :: dti
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Construct a Gregorian calendar date and time.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("dti = dateTimeInt_type(year = 2020_IK, zone = -5 * 60_IK, minute = 48_IK)")
                    dti = dateTimeInt_type(year = 2020_IK, zone = -5 * 60_IK, minute = 48_IK)
    call disp%show("write(disp%unit, ""(*(g0,:,', '))"") dti")
                    write(disp%unit, "(*(g0,:,', '))") dti
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Construct the current date and time and moment in the Gregorian calendar.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("dti = dateTimeInt_type()")
                    dti = dateTimeInt_type()
    call disp%show("write(disp%unit, ""(*(g0,:,', '))"") dti")
                    write(disp%unit, "(*(g0,:,', '))") dti
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Get the object components as a vector of `Values` as returned by the Fortran instrinsic `date_and_time()`.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("dti = dateTimeInt_type(year = 2020_IK, zone = -5 * 60_IK, minute = 48_IK)")
                    dti = dateTimeInt_type(year = 2020_IK, zone = -5 * 60_IK, minute = 48_IK)
    call disp%show("write(disp%unit, ""(*(g0,:,', '))"") dti")
                    write(disp%unit, "(*(g0,:,', '))") dti
    call disp%show("dti%getValues()")
    call disp%show( dti%getValues() )
    call disp%show("size(dti%getValues())")
    call disp%show( size(dti%getValues()) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Construct a Gregorian calendar date and time.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
dti = dateTimeInt_type(year = 2020_IK, zone = -5 * 60_IK, minute = 48_IK)
write(disp%unit, "(*(g0,:,', '))") dti
2020, 1, 1, -300, 0, 48, 0, 0
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Construct the current date and time and moment in the Gregorian calendar.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
dti = dateTimeInt_type()
write(disp%unit, "(*(g0,:,', '))") dti
2024, 8, 22, -240, 20, 22, 58, 207
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Get the object components as a vector of `Values` as returned by the Fortran instrinsic `date_and_time()`.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
dti = dateTimeInt_type(year = 2020_IK, zone = -5 * 60_IK, minute = 48_IK)
write(disp%unit, "(*(g0,:,', '))") dti
2020, 1, 1, -300, 0, 48, 0, 0
dti%getValues()
+2020, +1, +1, -300, +0, +48, +0, +0
size(dti%getValues())
+8
 
 

Test:

test_pm_dateTime

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas at Austin

Definition at line 895 of file pm_dateTime.F90.

Member Function/Subroutine Documentation

dateTimeInt_typer()

type(dateTimeInt_type) function pm_dateTime::dateTimeInt_type::dateTimeInt_typer

This is the constructor of the dateTimeInt_type class.

Upon return, the constructor initializes all components of the object to the current date and time.
See also the documentation details of dateTimeInt_type.

Returns

dateTimeInt : The output scalar object of class dateTimeInt_type.

Possible calling interfaces ⛓

use pm_dateTime, only: dateTimeInt_type
type(dateTimeInt_type) :: dateTimeInt
 
dateTimeInt = dateTimeInt_type()

Warning

All object components are set to -huge(0_K) if the processor does not provide date and time.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

Remarks

See the documentation of dateTimeInt_type for example usage.

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas at Austin

Definition at line 4092 of file pm_dateTime.F90.

getValues()

procedure, pass pm_dateTime::dateTimeInt_type::getValues

Definition at line 907 of file pm_dateTime.F90.

Member Data Documentation

day

integer(IK) pm_dateTime::dateTimeInt_type::day = 1_IK

The scalar integer of default kind IK containing the day of the month.

Definition at line 899 of file pm_dateTime.F90.

hour

integer(IK) pm_dateTime::dateTimeInt_type::hour = 0_IK

The scalar integer of default kind IK containing the hour of the day.

Definition at line 902 of file pm_dateTime.F90.

millisecond

integer(IK) pm_dateTime::dateTimeInt_type::millisecond = 0_IK

The scalar integer of default kind IK containing the milliseconds of the second.

Definition at line 905 of file pm_dateTime.F90.

minute

integer(IK) pm_dateTime::dateTimeInt_type::minute = 0_IK

The scalar integer of default kind IK containing the minute of the hour.

Definition at line 903 of file pm_dateTime.F90.

month

integer(IK) pm_dateTime::dateTimeInt_type::month = 1_IK

The scalar integer of default kind IK containing the month of the year.

Definition at line 898 of file pm_dateTime.F90.

second

integer(IK) pm_dateTime::dateTimeInt_type::second = 0_IK

The scalar integer of default kind IK containing the second of the minute.

Definition at line 904 of file pm_dateTime.F90.

year

integer(IK) pm_dateTime::dateTimeInt_type::year = 1_IK

The scalar integer of default kind IK containing the year of the Gregorian calendar.

Definition at line 897 of file pm_dateTime.F90.

zone

integer(IK) pm_dateTime::dateTimeInt_type::zone = 0_IK

The scalar integer of default kind IK containing the time difference in minutes with respect to the UTC.

Definition at line 900 of file pm_dateTime.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_dateTime.F90