Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 455

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: frepple::utils::TimePeriod Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet"  type="text/css">
</head>
<body>
<div id="container">

<div id="menubar"> 
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>  
</div>

<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00257.html">utils</a>::<a class="el" href="a00179.html">TimePeriod</a>
  </div>
</div>
<div class="contents">
<h1>frepple::utils::TimePeriod Class Reference</h1><!-- doxytag: class="frepple::utils::TimePeriod" -->
<p>This class represents a time duration with an accuracy of one second.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00252_source.html">utils.h</a>&gt;</code></p>

<p><a href="a00644.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#af62dfad87d4f91c7d71e439499a7d2f2">operator long</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a180cf65be258f700ed9f684eed42ab55">operator string</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ab571ae34a4f8b9f29ad855fd8003a72c">operator!</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ae2b8f81d659a6ecdb6937d238d9472fb">operator!=</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a533192b64ab4e89c504cb04e828b5a60">operator+=</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;l)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ad91f9614973780c04866c4c579e6e47a">operator-=</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;l)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a6842b0def84ac3cdc47ddd59f1f772af">operator&lt;</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a7f29c998353cbf9d67d4de8010ecdb80">operator&lt;</a> (const long &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a44414b11059e887069bc4651a605f9eb">operator&lt;=</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#af3ab9d75483c83dd0e209f06fe42607c">operator&lt;=</a> (const long &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#aef184d5657cd30ccb52202c6752e6c3a">operator==</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a1080b08f3499ec4d2aead08eefe18f57">operator&gt;</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#afb19838c60d78923a10de898dbf056a8">operator&gt;</a> (const long &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a43361766e4c1bae5e0eff90206df31f2">operator&gt;=</a> (const <a class="el" href="a00179.html">TimePeriod</a> &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a45d4227bf88a392504a1d29b415d7c2e">operator&gt;=</a> (const long &amp;b) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#a16a9ec9ceaf0cb43814c1119779027f6">parse</a> (const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ad29d61f16b3594123a45183587577d6b">TimePeriod</a> (const char *s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ae22127406291995d6690ac5f3a84071e">TimePeriod</a> (const long l=0)</td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00179.html">TimePeriod</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#abd75b4292e4d01ec927fafd8618f7587">MAX</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00179.html">TimePeriod</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#aa50d5181ad692fab538b49efe8d782a1">MIN</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ac4b8e3f105003fddc00826a4a26d6fa8">operator&lt;&lt;</a> (ostream &amp;, const <a class="el" href="a00179.html">TimePeriod</a> &amp;)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents a time duration with an accuracy of one second. </p>
<p>The duration can be both positive and negative. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01626">1626</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae22127406291995d6690ac5f3a84071e"></a><!-- doxytag: member="frepple::utils::TimePeriod::TimePeriod" ref="ae22127406291995d6690ac5f3a84071e" args="(const long l=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::utils::TimePeriod::TimePeriod </td>
          <td>(</td>
          <td class="paramtype">const long&nbsp;</td>
          <td class="paramname"> <em>l</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor and constructor with timeperiod passed. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01631">1631</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad29d61f16b3594123a45183587577d6b"></a><!-- doxytag: member="frepple::utils::TimePeriod::TimePeriod" ref="ad29d61f16b3594123a45183587577d6b" args="(const char *s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::utils::TimePeriod::TimePeriod </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>s</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor from a character string.<br/>
 See the <a class="el" href="a00179.html#a16a9ec9ceaf0cb43814c1119779027f6">parse()</a> method for details on the format of the argument. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01636">1636</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af62dfad87d4f91c7d71e439499a7d2f2"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator long" ref="af62dfad87d4f91c7d71e439499a7d2f2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::utils::TimePeriod::operator long </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This conversion operator creates a long value from a timeperiod. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01678">1678</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a180cf65be258f700ed9f684eed42ab55"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator string" ref="a180cf65be258f700ed9f684eed42ab55" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::utils::TimePeriod::operator string </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Converts the date to a string, formatted according to ISO 8601. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01681">1681</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab571ae34a4f8b9f29ad855fd8003a72c"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator!" ref="ab571ae34a4f8b9f29ad855fd8003a72c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator! </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns true of the duration is equal to 0. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01675">1675</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae2b8f81d659a6ecdb6937d238d9472fb"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator!=" ref="ae2b8f81d659a6ecdb6937d238d9472fb" args="(const TimePeriod &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Inequality operator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01666">1666</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a533192b64ab4e89c504cb04e828b5a60"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator+=" ref="a533192b64ab4e89c504cb04e828b5a60" args="(const TimePeriod &amp;l)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::TimePeriod::operator+= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>l</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Increase the timeperiod. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01669">1669</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad91f9614973780c04866c4c579e6e47a"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&#45;=" ref="ad91f9614973780c04866c4c579e6e47a" args="(const TimePeriod &amp;l)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::TimePeriod::operator-= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>l</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Decrease the timeperiod. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01672">1672</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6842b0def84ac3cdc47ddd59f1f772af"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&lt;" ref="a6842b0def84ac3cdc47ddd59f1f772af" args="(const TimePeriod &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&lt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01651">1651</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a7f29c998353cbf9d67d4de8010ecdb80"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&lt;" ref="a7f29c998353cbf9d67d4de8010ecdb80" args="(const long &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&lt; </td>
          <td>(</td>
          <td class="paramtype">const long &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01639">1639</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a44414b11059e887069bc4651a605f9eb"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&lt;=" ref="a44414b11059e887069bc4651a605f9eb" args="(const TimePeriod &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&lt;= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01657">1657</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="af3ab9d75483c83dd0e209f06fe42607c"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&lt;=" ref="af3ab9d75483c83dd0e209f06fe42607c" args="(const long &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&lt;= </td>
          <td>(</td>
          <td class="paramtype">const long &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01645">1645</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="aef184d5657cd30ccb52202c6752e6c3a"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator==" ref="aef184d5657cd30ccb52202c6752e6c3a" args="(const TimePeriod &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Equality operator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01663">1663</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1080b08f3499ec4d2aead08eefe18f57"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&gt;" ref="a1080b08f3499ec4d2aead08eefe18f57" args="(const TimePeriod &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&gt; </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01654">1654</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="afb19838c60d78923a10de898dbf056a8"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&gt;" ref="afb19838c60d78923a10de898dbf056a8" args="(const long &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&gt; </td>
          <td>(</td>
          <td class="paramtype">const long &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01642">1642</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a43361766e4c1bae5e0eff90206df31f2"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&gt;=" ref="a43361766e4c1bae5e0eff90206df31f2" args="(const TimePeriod &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&gt;= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01660">1660</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a45d4227bf88a392504a1d29b415d7c2e"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&gt;=" ref="a45d4227bf88a392504a1d29b415d7c2e" args="(const long &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::utils::TimePeriod::operator&gt;= </td>
          <td>(</td>
          <td class="paramtype">const long &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison between periods of time. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01648">1648</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a16a9ec9ceaf0cb43814c1119779027f6"></a><!-- doxytag: member="frepple::utils::TimePeriod::parse" ref="a16a9ec9ceaf0cb43814c1119779027f6" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void frepple::utils::TimePeriod::parse </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>s</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Function that parses a input string to a time value.<br/>
 The string format is following the ISO 8601 specification for durations: [-]P[nY][nM][nW][nD][T[nH][nM][nS]]<br/>
 Some examples to illustrate how the string is converted to a timeperiod, expressed in seconds:<br/>
 P1Y = 1 year = 365 days = 31536000 seconds P1M = 365/12 days = 2628000 seconds P1W = 1 week = 7 days = 604800 seconds -P1D = -1 day = -86400 seconds PT1H = 1 hour = 3600 seconds -PT1000000S = 1000000 seconds P1M1WT1H = 1 month + 1 week + 1 hour = 3236400 seconds It pretty strictly checks the spec, with a few exceptions:</p>
<ul>
<li>A week field ('W') may coexist with other units.</li>
<li>Decimal values are not supported.</li>
<li>The alternate format as a date and time is not supported. </li>
</ul>

<p>Definition at line <a class="el" href="a00198_source.html#l00143">143</a> of file <a class="el" href="a00198_source.html">date.cpp</a>.</p>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ac4b8e3f105003fddc00826a4a26d6fa8"></a><!-- doxytag: member="frepple::utils::TimePeriod::operator&lt;&lt;" ref="ac4b8e3f105003fddc00826a4a26d6fa8" args="(ostream &amp;, const TimePeriod &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ostream&amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00179.html">TimePeriod</a> &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="abd75b4292e4d01ec927fafd8618f7587"></a><!-- doxytag: member="frepple::utils::TimePeriod::MAX" ref="abd75b4292e4d01ec927fafd8618f7587" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00179.html">TimePeriod</a> <a class="el" href="a00179.html#abd75b4292e4d01ec927fafd8618f7587">frepple::utils::TimePeriod::MAX</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The maximum value for a timeperiod. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01708">1708</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa50d5181ad692fab538b49efe8d782a1"></a><!-- doxytag: member="frepple::utils::TimePeriod::MIN" ref="aa50d5181ad692fab538b49efe8d782a1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00179.html">TimePeriod</a> <a class="el" href="a00179.html#aa50d5181ad692fab538b49efe8d782a1">frepple::utils::TimePeriod::MIN</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The minimum value for a timeperiod. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l01711">1711</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
<li><a class="el" href="a00198_source.html">date.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>