<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::MapIndex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_map_index.html">MapIndex</a>
</div>
</div>
<div class="contents">
<h1>ost::MapIndex Class Reference</h1><!-- doxytag: class="ost::MapIndex" -->
<p>The <a class="el" href="classost_1_1_map_index.html" title="The MapIndex allows linear access into a MapTable, that otherwise could have its...">MapIndex</a> allows linear access into a <a class="el" href="classost_1_1_map_table.html" title="A map table allows for entities to be mapped (hash index) onto it.">MapTable</a>, that otherwise could have its elements being retrieved only by key.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p>
<p><a href="classost_1_1_map_index-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a8b918a2fb5e4f25a1e17f1619eaceb68">MapIndex</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty map index (pointing to nothing). <a href="#a8b918a2fb5e4f25a1e17f1619eaceb68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#ab2c6ea4c4c75e7a5f6b2291cfc732145">MapIndex</a> (<a class="el" href="classost_1_1_map_object.html">MapObject</a> *theObject)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a map index pointing to a specific map object. <a href="#ab2c6ea4c4c75e7a5f6b2291cfc732145"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a1dd0e50bf3ba74bd1672d0b94df81d11">MapIndex</a> (const <a class="el" href="classost_1_1_map_index.html">MapIndex</a> &theIndex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of a given map index. <a href="#a1dd0e50bf3ba74bd1672d0b94df81d11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a22d9648d6a719e8574dd494964033947">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dereference operator: the pointed object it is returned as void * for easy re-cast. <a href="#a22d9648d6a719e8574dd494964033947"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_map_index.html">MapIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a1dbf5329fc861e11c6c3a1fff8e245d1">operator=</a> (<a class="el" href="classost_1_1_map_object.html">MapObject</a> *theObject)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator to avoid implicit cast. <a href="#a1dbf5329fc861e11c6c3a1fff8e245d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_map_index.html">MapIndex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a2bb18d172d3066e9c50b2b8a82cd6a99">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prefix increment operator, to be used in loops and such. <a href="#a2bb18d172d3066e9c50b2b8a82cd6a99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_map_index.html">MapIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#af8d496fd333068047dd1c9eda08df5fe">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Postfix increment operator, to be used in loops and such. <a href="#af8d496fd333068047dd1c9eda08df5fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#ade088b57ac1fd4a3eca53d7ab364e002">operator==</a> (const <a class="el" href="classost_1_1_map_index.html">MapIndex</a> &theIndex) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator, between two MapIndex's. <a href="#ade088b57ac1fd4a3eca53d7ab364e002"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a45280851bb933b99fa8615bd2be96af0">operator!=</a> (const <a class="el" href="classost_1_1_map_index.html">MapIndex</a> &theIndex) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a3c4399bd0a54ffeac890c2f7040d0b71">operator==</a> (const <a class="el" href="classost_1_1_map_object.html">MapObject</a> *theObject) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator, between the <a class="el" href="classost_1_1_map_index.html" title="The MapIndex allows linear access into a MapTable, that otherwise could have its...">MapIndex</a> and a <a class="el" href="classost_1_1_map_object.html" title="The MapObject is a base class which can be used to make a derived class operate on...">MapObject</a>, useful to avoid casts for sake of clearness. <a href="#a3c4399bd0a54ffeac890c2f7040d0b71"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_map_index.html#a55357f847aaff7b53ce30e3575364ffa">operator!=</a> (const <a class="el" href="classost_1_1_map_object.html">MapObject</a> *theObject) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classost_1_1_map_index.html" title="The MapIndex allows linear access into a MapTable, that otherwise could have its...">MapIndex</a> allows linear access into a <a class="el" href="classost_1_1_map_table.html" title="A map table allows for entities to be mapped (hash index) onto it.">MapTable</a>, that otherwise could have its elements being retrieved only by key. </p>
<p>It can be increased, checked and dereferenced like a pointer, by means of suitable operators.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Sergio Repetto <<a href="mailto:s.repetto@pentaengineering.it">s.repetto@pentaengineering.it</a>> Index object to access <a class="el" href="classost_1_1_map_table.html" title="A map table allows for entities to be mapped (hash index) onto it.">MapTable</a> elements </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8b918a2fb5e4f25a1e17f1619eaceb68"></a><!-- doxytag: member="ost::MapIndex::MapIndex" ref="a8b918a2fb5e4f25a1e17f1619eaceb68" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::MapIndex::MapIndex </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an empty map index (pointing to nothing). </p>
</div>
</div>
<a class="anchor" id="ab2c6ea4c4c75e7a5f6b2291cfc732145"></a><!-- doxytag: member="ost::MapIndex::MapIndex" ref="ab2c6ea4c4c75e7a5f6b2291cfc732145" args="(MapObject *theObject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::MapIndex::MapIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_map_object.html">MapObject</a> * </td>
<td class="paramname"> <em>theObject</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a map index pointing to a specific map object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>the</em> </td><td>indexed object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1dd0e50bf3ba74bd1672d0b94df81d11"></a><!-- doxytag: member="ost::MapIndex::MapIndex" ref="a1dd0e50bf3ba74bd1672d0b94df81d11" args="(const MapIndex &theIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::MapIndex::MapIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_map_index.html">MapIndex</a> & </td>
<td class="paramname"> <em>theIndex</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a copy of a given map index. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>the</em> </td><td>source index object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a55357f847aaff7b53ce30e3575364ffa"></a><!-- doxytag: member="ost::MapIndex::operator!=" ref="a55357f847aaff7b53ce30e3575364ffa" args="(const MapObject *theObject) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::MapIndex::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_map_object.html">MapObject</a> * </td>
<td class="paramname"> <em>theObject</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a45280851bb933b99fa8615bd2be96af0"></a><!-- doxytag: member="ost::MapIndex::operator!=" ref="a45280851bb933b99fa8615bd2be96af0" args="(const MapIndex &theIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::MapIndex::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_map_index.html">MapIndex</a> & </td>
<td class="paramname"> <em>theIndex</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a22d9648d6a719e8574dd494964033947"></a><!-- doxytag: member="ost::MapIndex::operator*" ref="a22d9648d6a719e8574dd494964033947" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::MapIndex::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dereference operator: the pointed object it is returned as void * for easy re-cast. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to indexed object. </dd></dl>
</div>
</div>
<a class="anchor" id="af8d496fd333068047dd1c9eda08df5fe"></a><!-- doxytag: member="ost::MapIndex::operator++" ref="af8d496fd333068047dd1c9eda08df5fe" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_map_index.html">MapIndex</a> ost::MapIndex::operator++ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Postfix increment operator, to be used in loops and such. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the object itself, as changed. </dd></dl>
<p>References <a class="el" href="object_8h_source.html#l00528">operator++()</a>.</p>
<p>Referenced by <a class="el" href="object_8h_source.html#l00528">operator++()</a>.</p>
</div>
</div>
<a class="anchor" id="a2bb18d172d3066e9c50b2b8a82cd6a99"></a><!-- doxytag: member="ost::MapIndex::operator++" ref="a2bb18d172d3066e9c50b2b8a82cd6a99" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_map_index.html">MapIndex</a>& ost::MapIndex::operator++ </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prefix increment operator, to be used in loops and such. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="a1dbf5329fc861e11c6c3a1fff8e245d1"></a><!-- doxytag: member="ost::MapIndex::operator=" ref="a1dbf5329fc861e11c6c3a1fff8e245d1" args="(MapObject *theObject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_map_index.html">MapIndex</a>& ost::MapIndex::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_map_object.html">MapObject</a> * </td>
<td class="paramname"> <em>theObject</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator to avoid implicit cast. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="a3c4399bd0a54ffeac890c2f7040d0b71"></a><!-- doxytag: member="ost::MapIndex::operator==" ref="a3c4399bd0a54ffeac890c2f7040d0b71" args="(const MapObject *theObject) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::MapIndex::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_map_object.html">MapObject</a> * </td>
<td class="paramname"> <em>theObject</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator, between the <a class="el" href="classost_1_1_map_index.html" title="The MapIndex allows linear access into a MapTable, that otherwise could have its...">MapIndex</a> and a <a class="el" href="classost_1_1_map_object.html" title="The MapObject is a base class which can be used to make a derived class operate on...">MapObject</a>, useful to avoid casts for sake of clearness. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="ade088b57ac1fd4a3eca53d7ab364e002"></a><!-- doxytag: member="ost::MapIndex::operator==" ref="ade088b57ac1fd4a3eca53d7ab364e002" args="(const MapIndex &theIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::MapIndex::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_map_index.html">MapIndex</a> & </td>
<td class="paramname"> <em>theIndex</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator, between two MapIndex's. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="object_8h_source.html">object.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
253
