<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Yate: XMPPDirVal Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main 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> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1XMPPDirVal.html">XMPPDirVal</a> </div> </div> <div class="contents"> <h1>XMPPDirVal Class Reference</h1><!-- doxytag: class="TelEngine::XMPPDirVal" -->Direction flags. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="xmpputils_8h-source.html">xmpputils.h</a>></code> <p> <p> <a href="classTelEngine_1_1XMPPDirVal-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">enum </td><td class="memItemRight" valign="bottom"><b>Direction</b> { <b>None</b> = 0, <b>To</b> = 1, <b>From</b> = 2, <b>Both</b> = 3 }</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#25f58efe46fc1ed657e1ed2765849fb5">XMPPDirVal</a> (int flags=None)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#75daf172cde5e3b49407091a48c695e4">XMPPDirVal</a> (const char *name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#b56e6e3f728002d2ea019375d35abe2c">replace</a> (int flag)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#4c97148d804299e225842ac0ca7f5484">replace</a> (const char *name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#dfa51ca334b60884c4ff466cebfb782f">set</a> (int flag)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#18100976fb3f1c9e785cdf6c2e835df7">reset</a> (int flag)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#1b5e2d8e3d68180be05b6fac508e2751">flag</a> (int mask) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#ff1eaa1387361535aa1066f0361e6696">to</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#a533af399fff1b0a6edc2ee5027201d1">from</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#4f4ea421e40bda08a2deca657f640fea">operator int</a> ()</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 const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#bcbdfdf8442b4b7d560147a506873e10">lookup</a> (int flag, const char *defVal="")</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#da39e5bd4a98eed12d722904fe7463e4">lookup</a> (const char *name, int defVal=None)</td></tr> <tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1XMPPDirVal.html#9831b8c47b8ffdfab22389b0248cceca">s_names</a> []</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Direction flags. <p> This class holds a 4-state direction value (such as subscription states) <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="25f58efe46fc1ed657e1ed2765849fb5"></a><!-- doxytag: member="TelEngine::XMPPDirVal::XMPPDirVal" ref="25f58efe46fc1ed657e1ed2765849fb5" args="(int flags=None)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1XMPPDirVal.html">XMPPDirVal</a> </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>flags</em> = <code>None</code> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Flag(s) to set </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="75daf172cde5e3b49407091a48c695e4"></a><!-- doxytag: member="TelEngine::XMPPDirVal::XMPPDirVal" ref="75daf172cde5e3b49407091a48c695e4" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1XMPPDirVal.html">XMPPDirVal</a> </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the flag used to initialize this object </td></tr> </table> </dl> <p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="1b5e2d8e3d68180be05b6fac508e2751"></a><!-- doxytag: member="TelEngine::XMPPDirVal::flag" ref="1b5e2d8e3d68180be05b6fac508e2751" args="(int mask) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool flag </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>mask</em> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check if a given bit mask is set <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>Bit mask to check </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the given bit mask is set </dd></dl> </div> </div><p> <a class="anchor" name="a533af399fff1b0a6edc2ee5027201d1"></a><!-- doxytag: member="TelEngine::XMPPDirVal::from" ref="a533af399fff1b0a6edc2ee5027201d1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool from </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check if the 'From' flag is set <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the 'From' flag is set </dd></dl> </div> </div><p> <a class="anchor" name="da39e5bd4a98eed12d722904fe7463e4"></a><!-- doxytag: member="TelEngine::XMPPDirVal::lookup" ref="da39e5bd4a98eed12d722904fe7463e4" args="(const char *name, int defVal=None)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int lookup </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>defVal</em> = <code>None</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the value associated with a flag name <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The flag name </td></tr> <tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>Value to return if not found </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the requested flag name </dd></dl> <p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p> </div> </div><p> <a class="anchor" name="bcbdfdf8442b4b7d560147a506873e10"></a><!-- doxytag: member="TelEngine::XMPPDirVal::lookup" ref="bcbdfdf8442b4b7d560147a506873e10" args="(int flag, const char *defVal="")" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static const char* lookup </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>flag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>defVal</em> = <code>""</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the name of a flag <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The flag </td></tr> <tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>Value to return if not found </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the requested flag </dd></dl> <p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p> </div> </div><p> <a class="anchor" name="4f4ea421e40bda08a2deca657f640fea"></a><!-- doxytag: member="TelEngine::XMPPDirVal::operator int" ref="4f4ea421e40bda08a2deca657f640fea" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">operator int </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Cast operator </div> </div><p> <a class="anchor" name="4c97148d804299e225842ac0ca7f5484"></a><!-- doxytag: member="TelEngine::XMPPDirVal::replace" ref="4c97148d804299e225842ac0ca7f5484" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void replace </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Replace all flags from a value's name <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the flag used to replace this value </td></tr> </table> </dl> <p>References <a class="el" href="namespaceTelEngine.html#4668c9172c6ae5f59f5782ecc6e05516">TelEngine::lookup()</a>.</p> </div> </div><p> <a class="anchor" name="b56e6e3f728002d2ea019375d35abe2c"></a><!-- doxytag: member="TelEngine::XMPPDirVal::replace" ref="b56e6e3f728002d2ea019375d35abe2c" args="(int flag)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void replace </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>flag</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Replace all flags <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>The new value of the flags </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="18100976fb3f1c9e785cdf6c2e835df7"></a><!-- doxytag: member="TelEngine::XMPPDirVal::reset" ref="18100976fb3f1c9e785cdf6c2e835df7" args="(int flag)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void reset </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>flag</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Reset one or more flags <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>Flag(s) to reset </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="dfa51ca334b60884c4ff466cebfb782f"></a><!-- doxytag: member="TelEngine::XMPPDirVal::set" ref="dfa51ca334b60884c4ff466cebfb782f" args="(int flag)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void set </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>flag</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set one or more flags <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>Flag(s) to set </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="ff1eaa1387361535aa1066f0361e6696"></a><!-- doxytag: member="TelEngine::XMPPDirVal::to" ref="ff1eaa1387361535aa1066f0361e6696" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool to </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check if the 'To' flag is set <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the 'To' flag is set </dd></dl> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="9831b8c47b8ffdfab22389b0248cceca"></a><!-- doxytag: member="TelEngine::XMPPDirVal::s_names" ref="9831b8c47b8ffdfab22389b0248cceca" args="[]" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structTelEngine_1_1TokenDict.html">TokenDict</a> <a class="el" href="classTelEngine_1_1XMPPDirVal.html#9831b8c47b8ffdfab22389b0248cceca">s_names</a>[]<code> [static]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Keep the flag names </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="xmpputils_8h-source.html">xmpputils.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> </body> </html>