annotate mayachemtools/docs/modules/html/TimeUtil.html @ 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 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:TimeUtil.pm</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./TextUtil.html" title="TextUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./Vector.html" title="Vector.html">Next</a></td><td width="34%" align="middle"><strong>TimeUtil.pm</strong></td><td width="33%" align="right"><a href="././code/TimeUtil.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/TimeUtil.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/TimeUtil.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/TimeUtil.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/TimeUtil.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>TimeUtil</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>use TimeUtil;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use TimeUtil qw(:all);</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 <p><strong>TimeUtil</strong> module provides the following functions:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <p> <a href="#ctimestamp">CTimeStamp</a>, <a href="#fpfiletimestamp">FPFileTimeStamp</a>, <a href="#iso8601date">ISO8601Date</a>, <a href="#iso8601time">ISO8601Time</a>, <a href="#iso8601timestamp">ISO8601TimeStamp</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 , <a href="#monthnametonumber">MonthNameToNumber</a>, <a href="#monthnumbertoabbreviatedname">MonthNumberToAbbreviatedName</a>, <a href="#monthnumbertofullname">MonthNumberToFullName</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 , <a href="#pdbfiletimestamp">PDBFileTimeStamp</a>, <a href="#sdfiletimestamp">SDFileTimeStamp</a>, <a href="#timestamp">TimeStamp</a>, <a href="#weekdaynametonumber">WeekDayNameToNumber</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 , <a href="#weekdaynumbertoabbreviatedname">WeekDayNumberToAbbreviatedName</a>, <a href="#weekdaynumbertofullname">WeekDayNumberToFullName</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 </p><p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 <h2>FUNCTIONS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 <dt><strong><a name="ctimestamp" class="item"><strong>CTimeStamp</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 $CTimeStamp = CTimeStamp();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <p>Returns <strong>CTimeStamp</strong> string using the following format: WDay Mon MDay HH:MM:SS YYYY</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 <dt><strong><a name="fpfiletimestamp" class="item"><strong>FPFileTimeStamp</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 $FPFileTimeStamp = FPFileTimeStamp();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <p>Returns fingerints <strong>FP</strong> file time stamp string for MayaChemTools package. It corresponds to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 <strong>CTimeStamp</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 <dt><strong><a name="iso8601date" class="item"><strong>ISO8601Date</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 $Date = ISO8601Date();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <p>Returns ISO8601 <strong>Date</strong> string using the following format: [YYYY]-[MM]-[DD]</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 <dt><strong><a name="iso8601time" class="item"><strong>ISO8601Time</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 $Time = ISO8601Time();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <p>Returns ISO8601 <strong>Time</strong> string using the following extended format: [hh]:[mm]:[ss]</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <dt><strong><a name="iso8601timestamp" class="item"><strong>ISO8601TimeStamp</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 $TimeStamp = ISO8601TimeStamp();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 <p>Returns ISO8601 <strong>TimeStamp</strong> string using the following extended format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <dt><strong><a name="monthnametonumber" class="item"><strong>MonthNameToNumber</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 $Number = MonthNameToNumber($Name);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 <p>Return month <strong>Number</strong> for full month <em>Name</em> or three letter abbreviated month <em>Name</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 <dt><strong><a name="monthnumbertoabbreviatedname" class="item"><strong>MonthNumberToAbbreviatedName</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 $AbbrevMonthName = MonthNumberToAbbreviatedName($Number);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <p>Returns three letter <strong>AbbrevMonthName</strong> for month <em>Number</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 <dt><strong><a name="monthnumbertofullname" class="item"><strong>MonthNumberToFullName</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 $Name = MonthNumberToFullName($Number);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 <p>Returns full month <strong>Name</strong> for month <em>Number</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <dt><strong><a name="pdbfiletimestamp" class="item"><strong>PDBFileTimeStamp</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 $TimeStamp = PDBFileTimeStamp();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 <p>Returns PDB file <strong>TimeStamp</strong> using the following format: DD-MMM-YY</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 <dt><strong><a name="sdfiletimestamp" class="item"><strong>SDFileTimeStamp</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 $TimeStamp = SDFileTimeStamp();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 <p>Returns SD file <strong>TimeStamp</strong> using the following format: MMDDYYHHMM</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <dt><strong><a name="timestamp" class="item"><strong>TimeStamp</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 $TimeStamp = TimeStamp();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <p>Returns deafult <em>TimeStamp</em> for MayaChemTools. It corresponds to <strong>CTimeStamp</strong>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <dt><strong><a name="weekdaynametonumber" class="item"><strong>WeekDayNameToNumber</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 $Number = WeekDayNameToNumber($Name);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 <p>Returns week day <strong>Number</strong> from full week day <em>Name</em> or three letter abbreviated week
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 day <em>Name</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 <dt><strong><a name="weekdaynumbertoabbreviatedname" class="item"><strong>WeekDayNumberToAbbreviatedName</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 $Name = WeekDayNumberToAbbreviatedName($Number);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 <p>Returns three letter abbreviates week day <strong>Name</strong> for week day <em>Number</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 <dt><strong><a name="weekdaynumbertofullname" class="item"><strong>WeekDayNumberToFullName</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 $Name = WeekDayNumberToFullName($Number);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 <p>Returns full week day <strong>Name</strong> for week day <em>Number</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 <p><a href="./FileUtil.html">FileUtil.pm</a>,&nbsp<a href="./TextUtil.html">TextUtil.pm</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 <tr align="left" valign="top"><td width="33%" align="left"><a href="./TextUtil.html" title="TextUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./Vector.html" title="Vector.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>TimeUtil.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 </html>