annotate docs/modules/txt/TimeUtil.txt @ 3:90ea638ce878 draft default tip

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