XQuilla/docs/simple-api/classTimezone.html
2020-02-17 22:12:51 +01:00

276 lines
13 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</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>
<h1>Timezone Class Reference</h1><!-- doxytag: class="Timezone" --><!-- doxytag: inherits="ReferenceCounted" --><code>#include &lt;<a class="el" href="Timezone_8hpp-source.html">Timezone.hpp</a>&gt;</code>
<p>
Inheritance diagram for Timezone:<p><center><img src="classTimezone__inherit__graph.png" border="0" usemap="#Timezone__inherit__map" alt="Inheritance graph"></center>
<map name="Timezone__inherit__map">
<area href="classReferenceCounted.html" shape="rect" coords="5,7,152,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classTimezone-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; const <br>
<a class="el" href="classTimezone.html">Timezone</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#3114e9a999aa7d489e42cf1751da6a2c">Ptr</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#d6de4d7e7919efd4ac234527582969e2">Timezone</a> (const MAPM &amp;seconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#d6de4d7e7919efd4ac234527582969e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#91b37348c6ab14e7a6b566f56efaa071">Timezone</a> (const <a class="el" href="classRefCountPointer.html">ATDurationOrDerived::Ptr</a> &amp;duration, const <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#91b37348c6ab14e7a6b566f56efaa071"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#ebba0be59058b5d1773e355427a6292d">equals</a> (const <a class="el" href="classRefCountPointer.html">Timezone::Ptr</a> &amp;other) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if other is equal to this, false otherwise. <a href="#ebba0be59058b5d1773e355427a6292d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRefCountPointer.html">ATDurationOrDerived::Ptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#650b0d1cad584a4240fddb5eceedf457">asDayTimeDuration</a> (const <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#0b8148b4c6fa10a1070c7086933422ac">asString</a> (const <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a string representation of this <a class="el" href="classTimezone.html">Timezone</a>. <a href="#0b8148b4c6fa10a1070c7086933422ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const MAPM &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#8d19e2b7f46c73489df06e4a0e2b4e56">asSeconds</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the whole timezone expressed in seconds. <a href="#8d19e2b7f46c73489df06e4a0e2b4e56"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static MAPM&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#54cc8874c28699d09142c6cb3e4760d0">convert</a> (bool positive, int hour, int minute)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#136b61340cfdb5c6f514fabd6d5b6ba9">validate</a> (const MAPM &amp;tz)</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="3114e9a999aa7d489e42cf1751da6a2c"></a><!-- doxytag: member="Timezone::Ptr" ref="3114e9a999aa7d489e42cf1751da6a2c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt;const <a class="el" href="classTimezone.html">Timezone</a>&gt; <a class="el" href="classRefCountPointer.html">Timezone::Ptr</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d6de4d7e7919efd4ac234527582969e2"></a><!-- doxytag: member="Timezone::Timezone" ref="d6de4d7e7919efd4ac234527582969e2" args="(const MAPM &amp;seconds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Timezone::Timezone </td>
<td>(</td>
<td class="paramtype">const MAPM &amp;&nbsp;</td>
<td class="paramname"> <em>seconds</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Creates a <a class="el" href="classTimezone.html">Timezone</a> representing the given number of seconds.
</div>
</div><p>
<a class="anchor" name="91b37348c6ab14e7a6b566f56efaa071"></a><!-- doxytag: member="Timezone::Timezone" ref="91b37348c6ab14e7a6b566f56efaa071" args="(const ATDurationOrDerived::Ptr &amp;duration, const DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Timezone::Timezone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">ATDurationOrDerived::Ptr</a> &amp;&nbsp;</td>
<td class="paramname"> <em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Creates a <a class="el" href="classTimezone.html">Timezone</a> representing the given duration.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ebba0be59058b5d1773e355427a6292d"></a><!-- doxytag: member="Timezone::equals" ref="ebba0be59058b5d1773e355427a6292d" args="(const Timezone::Ptr &amp;other) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Timezone::equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">Timezone::Ptr</a> &amp;&nbsp;</td>
<td class="paramname"> <em>other</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if other is equal to this, false otherwise.
<p>
</div>
</div><p>
<a class="anchor" name="650b0d1cad584a4240fddb5eceedf457"></a><!-- doxytag: member="Timezone::asDayTimeDuration" ref="650b0d1cad584a4240fddb5eceedf457" args="(const DynamicContext *context) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">ATDurationOrDerived::Ptr</a> Timezone::asDayTimeDuration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0b8148b4c6fa10a1070c7086933422ac"></a><!-- doxytag: member="Timezone::asString" ref="0b8148b4c6fa10a1070c7086933422ac" args="(const DynamicContext *context) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh* Timezone::asString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a string representation of this <a class="el" href="classTimezone.html">Timezone</a>.
<p>
If positive, does print leading '+' sign, and if UTC returns "Z".
</div>
</div><p>
<a class="anchor" name="8d19e2b7f46c73489df06e4a0e2b4e56"></a><!-- doxytag: member="Timezone::asSeconds" ref="8d19e2b7f46c73489df06e4a0e2b4e56" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const MAPM&amp; Timezone::asSeconds </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the whole timezone expressed in seconds.
<p>
</div>
</div><p>
<a class="anchor" name="54cc8874c28699d09142c6cb3e4760d0"></a><!-- doxytag: member="Timezone::convert" ref="54cc8874c28699d09142c6cb3e4760d0" args="(bool positive, int hour, int minute)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static MAPM Timezone::convert </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>positive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>hour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>minute</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="136b61340cfdb5c6f514fabd6d5b6ba9"></a><!-- doxytag: member="Timezone::validate" ref="136b61340cfdb5c6f514fabd6d5b6ba9" args="(const MAPM &amp;tz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Timezone::validate </td>
<td>(</td>
<td class="paramtype">const MAPM &amp;&nbsp;</td>
<td class="paramname"> <em>tz</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Timezone_8hpp-source.html">Timezone.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 20:16:59 2007 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>