annotate mayachemtools/docs/modules/txt/TimeUtil.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 TimeUtil
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use TimeUtil;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 use TimeUtil qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 TimeUtil module provides the following functions:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 CTimeStamp, FPFileTimeStamp, ISO8601Date, ISO8601Time, ISO8601TimeStamp,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 MonthNameToNumber, MonthNumberToAbbreviatedName, MonthNumberToFullName,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 PDBFileTimeStamp, SDFileTimeStamp, TimeStamp, WeekDayNameToNumber,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 WeekDayNumberToAbbreviatedName, WeekDayNumberToFullName
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 FUNCTIONS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 CTimeStamp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 $CTimeStamp = CTimeStamp();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 Returns CTimeStamp string using the following format: WDay Mon MDay
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 HH:MM:SS YYYY
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 FPFileTimeStamp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 $FPFileTimeStamp = FPFileTimeStamp();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 Returns fingerints FP file time stamp string for MayaChemTools
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 package. It corresponds to CTimeStamp.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 ISO8601Date
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 $Date = ISO8601Date();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 Returns ISO8601 Date string using the following format:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 [YYYY]-[MM]-[DD]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 ISO8601Time
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 $Time = ISO8601Time();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 Returns ISO8601 Time string using the following extended format:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 [hh]:[mm]:[ss]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 ISO8601TimeStamp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 $TimeStamp = ISO8601TimeStamp();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 Returns ISO8601 TimeStamp string using the following extended
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 MonthNameToNumber
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 $Number = MonthNameToNumber($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 Return month Number for full month *Name* or three letter
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 abbreviated month *Name*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 MonthNumberToAbbreviatedName
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 $AbbrevMonthName = MonthNumberToAbbreviatedName($Number);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 Returns three letter AbbrevMonthName for month *Number*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 MonthNumberToFullName
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 $Name = MonthNumberToFullName($Number);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 Returns full month Name for month *Number*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 PDBFileTimeStamp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 $TimeStamp = PDBFileTimeStamp();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 Returns PDB file TimeStamp using the following format: DD-MMM-YY
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 SDFileTimeStamp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 $TimeStamp = SDFileTimeStamp();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 Returns SD file TimeStamp using the following format: MMDDYYHHMM
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 TimeStamp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 $TimeStamp = TimeStamp();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 Returns deafult *TimeStamp* for MayaChemTools. It corresponds to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 CTimeStamp.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 WeekDayNameToNumber
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 $Number = WeekDayNameToNumber($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 Returns week day Number from full week day *Name* or three letter
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 abbreviated week day *Name*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 WeekDayNumberToAbbreviatedName
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 $Name = WeekDayNumberToAbbreviatedName($Number);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 Returns three letter abbreviates week day Name for week day
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 *Number*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 WeekDayNumberToFullName
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 $Name = WeekDayNumberToFullName($Number);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 Returns full week day Name for week day *Number*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 FileUtil.pm, TextUtil.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112