XQuilla/docs/simple-api/classTimezone.html

336 lines
14 KiB
HTML
Raw Normal View History

2020-02-17 22:05:20 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2020-02-17 22:11:31 +01:00
<title>XQilla Simple API Documentation</title>
2020-02-17 22:05:20 +01:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 22:11:31 +01:00
<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>
2020-02-17 22:19:08 +01:00
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>Timezone Class Reference</h1><code>#include &lt;<a class="el" href="Timezone_8hpp-source.html">Timezone.hpp</a>&gt;</code>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
Inheritance diagram for Timezone:<p><center><img src="classTimezone__inherit__graph.png" border="0" usemap="#Timezone__inherit__map" alt="Inheritance graph"></center>
2020-02-17 22:05:20 +01:00
<map name="Timezone__inherit__map">
2020-02-17 22:19:08 +01:00
<area href="classReferenceCounted.html" shape="rect" coords="5,7,136,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">
2020-02-17 22:05:20 +01:00
<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>
2020-02-17 22:19:08 +01:00
<a class="el" href="classTimezone.html">Timezone</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#w0">Ptr</a></td></tr>
2020-02-17 22:05:20 +01:00
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a0">Timezone</a> (const MAPM &amp;seconds)</td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#a0"></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#a1">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>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#a1"></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#a2">equals</a> (const <a class="el" href="classRefCountPointer.html">Timezone::Ptr</a> &amp;other) const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if other is equal to this, false otherwise. <a href="#a2"></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#a3">asDayTimeDuration</a> (const <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#a4">asString</a> (const <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a string representation of this Timezone. <a href="#a4"></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#a5">asSeconds</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the whole timezone expressed in seconds. <a href="#a5"></a><br></td></tr>
2020-02-17 22:05:20 +01:00
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">MAPM&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#e0">convert</a> (bool positive, int hour, int minute)</td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTimezone.html#e1">validate</a> (const MAPM &amp;tz)</td></tr>
2020-02-17 22:05:20 +01:00
</table>
<hr><h2>Member Typedef Documentation</h2>
2020-02-17 22:19:08 +01:00
<a class="anchor" name="w0" doxytag="Timezone::Ptr"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">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>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
2020-02-17 22:05:20 +01:00
<hr><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 22:19:08 +01:00
<a class="anchor" name="a0" doxytag="Timezone::Timezone"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">Timezone::Timezone </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const MAPM &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>seconds</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
Constructor.
<p>
2020-02-17 22:19:08 +01:00
Creates a Timezone representing the given number of seconds. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="Timezone::Timezone"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">Timezone::Timezone </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classRefCountPointer.html">ATDurationOrDerived::Ptr</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>duration</em>, </td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>context</em></td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
Constructor.
<p>
2020-02-17 22:19:08 +01:00
Creates a Timezone representing the given duration. </td>
</tr>
</table>
2020-02-17 22:05:20 +01:00
<hr><h2>Member Function Documentation</h2>
2020-02-17 22:19:08 +01:00
<a class="anchor" name="a3" doxytag="Timezone::asDayTimeDuration"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top"><a class="el" href="classRefCountPointer.html">ATDurationOrDerived::Ptr</a> Timezone::asDayTimeDuration </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>context</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="Timezone::asSeconds"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">const MAPM&amp; Timezone::asSeconds </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
Returns the whole timezone expressed in seconds.
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="Timezone::asString"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">const XMLCh* Timezone::asString </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>context</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
2020-02-17 22:05:20 +01:00
</tr>
2020-02-17 22:10:06 +01:00
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:10:06 +01:00
<p>
2020-02-17 22:19:08 +01:00
Returns a string representation of this Timezone.
2020-02-17 22:10:06 +01:00
<p>
2020-02-17 22:19:08 +01:00
If positive, does print leading '+' sign, and if UTC returns "Z". </td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="Timezone::convert"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">MAPM Timezone::convert </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">bool&nbsp;</td>
<td class="mdname" nowrap> <em>positive</em>, </td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>hour</em>, </td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>minute</em></td>
2020-02-17 22:05:20 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [static]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="Timezone::equals"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">bool Timezone::equals </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classRefCountPointer.html">Timezone::Ptr</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>other</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:19:08 +01:00
Returns true if other is equal to this, false otherwise.
<p>
</td>
</tr>
</table>
<a class="anchor" name="e1" doxytag="Timezone::validate"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void Timezone::validate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const MAPM &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>tz</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:10:06 +01:00
2020-02-17 22:19:08 +01:00
<p>
</td>
</tr>
</table>
2020-02-17 22:05:20 +01:00
<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>
2020-02-17 22:19:08 +01:00
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:41 2009 for XQilla Simple API by&nbsp;
2020-02-17 22:05:20 +01:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 22:19:08 +01:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
2020-02-17 22:05:20 +01:00
</body>
</html>