📄 classpordinalkey.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>POrdinalKey class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>POrdinalKey Class Reference</h1><code>#include <<a class="el" href="dict_8h-source.html">dict.h</a>></code><p><p>Inheritance diagram for POrdinalKey:<p><center><img src="classPOrdinalKey.png" usemap="#POrdinalKey_map" border="0" alt=""></center><map name="POrdinalKey_map"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,84,24"></map><a href="classPOrdinalKey-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 Methods</h2></td></tr><tr><td colspan="2"><div class="groupHeader">Construction</div></td></tr><tr><td nowrap align=right valign=top>PINLINE </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z81_0">POrdinalKey</a> (PINDEX newKey=0)</td></tr><tr><td nowrap align=right valign=top>PINLINE POrdinalKey & </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z81_1">operator=</a> (PINDEX)</td></tr><tr><td colspan="2"><div class="groupHeader">Overrides from class PObject</div></td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPObject.html">PObject</a> * </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z83_0">Clone</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Create a duplicate of the POrdinalKey.</em> <a href="#z83_0"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPObject.html#z199_0">Comparison</a> </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z83_1">Compare</a> (const <a class="el" href="classPObject.html">PObject</a> &obj) const</td></tr><tr><td nowrap align=right valign=top>virtual PINDEX </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z83_2">HashFunction</a> () const</td></tr><tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z83_3">PrintOn</a> (ostream &strm) const</td></tr><tr><td colspan="2"><div class="groupHeader">New functions for class</div></td></tr><tr><td nowrap align=right valign=top>PINLINE </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_0">operator PINDEX</a> () const</td></tr><tr><td nowrap align=right valign=top>PINLINE PINDEX </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_1">operator++</a> ()</td></tr><tr><td nowrap align=right valign=top>PINLINE PINDEX </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_2">operator++</a> (int)</td></tr><tr><td nowrap align=right valign=top>PINLINE PINDEX </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_3">operator--</a> ()</td></tr><tr><td nowrap align=right valign=top>PINLINE PINDEX </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_4">operator--</a> (int)</td></tr><tr><td nowrap align=right valign=top>PINLINE POrdinalKey & </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_5">operator+=</a> (PINDEX)</td></tr><tr><td nowrap align=right valign=top>PINLINE POrdinalKey & </td><td valign=bottom><a class="el" href="classPOrdinalKey.html#z85_6">operator-=</a> (PINDEX)</td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>This class is used when an ordinal index value is the key for PSet# and PDictionary# classes. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="z81_0" doxytag="POrdinalKey::POrdinalKey"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PINLINE POrdinalKey::POrdinalKey </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">PINDEX </td> <td class="mdname1" valign="top" nowrap> <em>newKey</em> = 0 </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a new key for ordinal index values. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>newKey</em> </td><td>Ordinal index value to use as a key. </td></tr></table></dl> </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="z83_0" doxytag="POrdinalKey::Clone"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classPObject.html">PObject</a>* POrdinalKey::Clone </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a duplicate of the POrdinalKey.<p><p>Reimplemented from <a class="el" href="classPObject.html#z203_0">PObject</a>. </td> </tr></table><a name="z83_1" doxytag="POrdinalKey::Compare"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classPObject.html#z199_0">Comparison</a> POrdinalKey::Compare </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPObject.html">PObject</a> & </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const<code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Compare the two objects and return their relative rank. This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.<p>The default function is to use the <a class="el" href="classPObject.html#z199_2">CompareObjectMemoryDirect()</a># function to do a byte wise memory comparison of the two objects.<p><dl compact><dt><b>Returns: </b></dt><dd> <a class="el" href="classPObject.html#z199_0s0">LessThan</a>#, <a class="el" href="classPObject.html#z199_0s1">EqualTo</a># or <a class="el" href="classPObject.html#z199_0s2">GreaterThan</a># according to the relative rank of the objects. </dl><p>Reimplemented from <a class="el" href="classPObject.html#z199_1">PObject</a>. </td> </tr></table><a name="z83_2" doxytag="POrdinalKey::HashFunction"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual PINDEX POrdinalKey::HashFunction </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>This function calculates a hash table index value for the implementation of PSet# and PDictionary# classes.<p><dl compact><dt><b>Returns: </b></dt><dd> hash table bucket number. </dl><p>Reimplemented from <a class="el" href="classPObject.html#z203_1">PObject</a>. </td> </tr></table><a name="z85_0" doxytag="POrdinalKey::operator PINDEX"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PINLINE POrdinalKey::operator PINDEX </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Operator so that a POrdinalKey can be used as a PINDEX value. </td> </tr></table><a name="z85_2" doxytag="POrdinalKey::operator++"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PINLINE PINDEX POrdinalKey::operator++ </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -