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