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

264 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.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="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="examples.html"><span>Examples</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>
<div class="contents">
<h1>Timezone Class Reference</h1><!-- doxytag: class="Timezone" --><!-- doxytag: inherits="ReferenceCounted" -->
<p><code>#include &lt;<a class="el" href="Timezone_8hpp_source.html">Timezone.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Timezone:</div>
<div class="dynsection">
<div class="center"><img src="classTimezone__inherit__graph.png" border="0" usemap="#Timezone_inherit__map" alt="Inheritance graph"/></div>
<map name="Timezone_inherit__map" id="Timezone_inherit__map">
<area shape="rect" href="classReferenceCounted.html" title="Super class for reference counted classes." alt="" coords="5,5,133,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classTimezone-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; const <br class="typebreak"/>
<a class="el" href="classTimezone.html">Timezone</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a3114e9a999aa7d489e42cf1751da6a2c">Ptr</a></td></tr>
<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="classTimezone.html#ad6de4d7e7919efd4ac234527582969e2">Timezone</a> (const MAPM &amp;seconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#ad6de4d7e7919efd4ac234527582969e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a91b37348c6ab14e7a6b566f56efaa071">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="#a91b37348c6ab14e7a6b566f56efaa071"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#aa4e7cd62a73beb70ae12541586711de0">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="#aa4e7cd62a73beb70ae12541586711de0"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a650b0d1cad584a4240fddb5eceedf457">asDayTimeDuration</a> (const <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a0b8148b4c6fa10a1070c7086933422ac">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="#a0b8148b4c6fa10a1070c7086933422ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const MAPM &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a155a5df6e710b94687c28500a54046e6">asSeconds</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the whole timezone expressed in seconds. <a href="#a155a5df6e710b94687c28500a54046e6"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static MAPM&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a54cc8874c28699d09142c6cb3e4760d0">convert</a> (bool positive, int hour, int minute)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a136b61340cfdb5c6f514fabd6d5b6ba9">validate</a> (const MAPM &amp;tz)</td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a3114e9a999aa7d489e42cf1751da6a2c"></a><!-- doxytag: member="Timezone::Ptr" ref="a3114e9a999aa7d489e42cf1751da6a2c" 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">
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad6de4d7e7919efd4ac234527582969e2"></a><!-- doxytag: member="Timezone::Timezone" ref="ad6de4d7e7919efd4ac234527582969e2" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Creates a <a class="el" href="classTimezone.html">Timezone</a> representing the given number of seconds. </p>
</div>
</div>
<a class="anchor" id="a91b37348c6ab14e7a6b566f56efaa071"></a><!-- doxytag: member="Timezone::Timezone" ref="a91b37348c6ab14e7a6b566f56efaa071" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Creates a <a class="el" href="classTimezone.html">Timezone</a> representing the given duration. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a650b0d1cad584a4240fddb5eceedf457"></a><!-- doxytag: member="Timezone::asDayTimeDuration" ref="a650b0d1cad584a4240fddb5eceedf457" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a155a5df6e710b94687c28500a54046e6"></a><!-- doxytag: member="Timezone::asSeconds" ref="a155a5df6e710b94687c28500a54046e6" 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> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the whole timezone expressed in seconds. </p>
</div>
</div>
<a class="anchor" id="a0b8148b4c6fa10a1070c7086933422ac"></a><!-- doxytag: member="Timezone::asString" ref="a0b8148b4c6fa10a1070c7086933422ac" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a string representation of this <a class="el" href="classTimezone.html">Timezone</a>. </p>
<p>If positive, does print leading '+' sign, and if UTC returns "Z". </p>
</div>
</div>
<a class="anchor" id="a54cc8874c28699d09142c6cb3e4760d0"></a><!-- doxytag: member="Timezone::convert" ref="a54cc8874c28699d09142c6cb3e4760d0" 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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa4e7cd62a73beb70ae12541586711de0"></a><!-- doxytag: member="Timezone::equals" ref="aa4e7cd62a73beb70ae12541586711de0" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if other is equal to this, false otherwise. </p>
</div>
</div>
<a class="anchor" id="a136b61340cfdb5c6f514fabd6d5b6ba9"></a><!-- doxytag: member="Timezone::validate" ref="a136b61340cfdb5c6f514fabd6d5b6ba9" 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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Mar 1 21:16:15 2010 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>