<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::MapIndex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_map_index.html">MapIndex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_map_index-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::MapIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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 elements being retri...">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="classost_1_1_map_index.html#details">More...</a></p>
<p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8b918a2fb5e4f25a1e17f1619eaceb68"><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 class="memdesc:a8b918a2fb5e4f25a1e17f1619eaceb68"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty map index (pointing to nothing). <a href="#a8b918a2fb5e4f25a1e17f1619eaceb68">More...</a><br/></td></tr>
<tr class="separator:a8b918a2fb5e4f25a1e17f1619eaceb68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2c6ea4c4c75e7a5f6b2291cfc732145"><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 class="memdesc:ab2c6ea4c4c75e7a5f6b2291cfc732145"><td class="mdescLeft"> </td><td class="mdescRight">Creates a map index pointing to a specific map object. <a href="#ab2c6ea4c4c75e7a5f6b2291cfc732145">More...</a><br/></td></tr>
<tr class="separator:ab2c6ea4c4c75e7a5f6b2291cfc732145"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1dd0e50bf3ba74bd1672d0b94df81d11"><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 class="memdesc:a1dd0e50bf3ba74bd1672d0b94df81d11"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of a given map index. <a href="#a1dd0e50bf3ba74bd1672d0b94df81d11">More...</a><br/></td></tr>
<tr class="separator:a1dd0e50bf3ba74bd1672d0b94df81d11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22d9648d6a719e8574dd494964033947"><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 class="memdesc:a22d9648d6a719e8574dd494964033947"><td class="mdescLeft"> </td><td class="mdescRight">Dereference operator: the pointed object it is returned as void * for easy re-cast. <a href="#a22d9648d6a719e8574dd494964033947">More...</a><br/></td></tr>
<tr class="separator:a22d9648d6a719e8574dd494964033947"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1dbf5329fc861e11c6c3a1fff8e245d1"><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 class="memdesc:a1dbf5329fc861e11c6c3a1fff8e245d1"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator to avoid implicit cast. <a href="#a1dbf5329fc861e11c6c3a1fff8e245d1">More...</a><br/></td></tr>
<tr class="separator:a1dbf5329fc861e11c6c3a1fff8e245d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bb18d172d3066e9c50b2b8a82cd6a99"><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 class="memdesc:a2bb18d172d3066e9c50b2b8a82cd6a99"><td class="mdescLeft"> </td><td class="mdescRight">Prefix increment operator, to be used in loops and such. <a href="#a2bb18d172d3066e9c50b2b8a82cd6a99">More...</a><br/></td></tr>
<tr class="separator:a2bb18d172d3066e9c50b2b8a82cd6a99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8d496fd333068047dd1c9eda08df5fe"><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 class="memdesc:af8d496fd333068047dd1c9eda08df5fe"><td class="mdescLeft"> </td><td class="mdescRight">Postfix increment operator, to be used in loops and such. <a href="#af8d496fd333068047dd1c9eda08df5fe">More...</a><br/></td></tr>
<tr class="separator:af8d496fd333068047dd1c9eda08df5fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade088b57ac1fd4a3eca53d7ab364e002"><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 class="memdesc:ade088b57ac1fd4a3eca53d7ab364e002"><td class="mdescLeft"> </td><td class="mdescRight">Comparison operator, between two <a class="el" href="classost_1_1_map_index.html" title="The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retri...">MapIndex</a>'s. <a href="#ade088b57ac1fd4a3eca53d7ab364e002">More...</a><br/></td></tr>
<tr class="separator:ade088b57ac1fd4a3eca53d7ab364e002"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45280851bb933b99fa8615bd2be96af0"><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 class="separator:a45280851bb933b99fa8615bd2be96af0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c4399bd0a54ffeac890c2f7040d0b71"><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 class="memdesc:a3c4399bd0a54ffeac890c2f7040d0b71"><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 elements being retri...">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 a MapTable...">MapObject</a>, useful to avoid casts for sake of clearness. <a href="#a3c4399bd0a54ffeac890c2f7040d0b71">More...</a><br/></td></tr>
<tr class="separator:a3c4399bd0a54ffeac890c2f7040d0b71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55357f847aaff7b53ce30e3575364ffa"><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>
<tr class="separator:a55357f847aaff7b53ce30e3575364ffa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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 elements being retri...">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="section author"><dt>Author</dt><dd>Sergio Repetto <a href="#" onclick="location.href='mai'+'lto:'+'s.r'+'ep'+'ett'+'o@'+'pen'+'ta'+'eng'+'in'+'eer'+'in'+'g.i'+'t'; return false;">s.rep<span style="display: none;">.nosp@m.</span>etto<span style="display: none;">.nosp@m.</span>@pent<span style="display: none;">.nosp@m.</span>aeng<span style="display: none;">.nosp@m.</span>ineer<span style="display: none;">.nosp@m.</span>ing.<span style="display: none;">.nosp@m.</span>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>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8b918a2fb5e4f25a1e17f1619eaceb68"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ost::MapIndex::MapIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a map index pointing to a specific map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">the</td><td>indexed object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1dd0e50bf3ba74bd1672d0b94df81d11"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a copy of a given map index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">the</td><td>source index object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a45280851bb933b99fa8615bd2be96af0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a55357f847aaff7b53ce30e3575364ffa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a22d9648d6a719e8574dd494964033947"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* ost::MapIndex::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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="section return"><dt>Returns</dt><dd>pointer to indexed object. </dd></dl>
</div>
</div>
<a class="anchor" id="a2bb18d172d3066e9c50b2b8a82cd6a99"></a>
<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="section return"><dt>Returns</dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="af8d496fd333068047dd1c9eda08df5fe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Postfix increment operator, to be used in loops and such. </p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="a1dbf5329fc861e11c6c3a1fff8e245d1"></a>
<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="section return"><dt>Returns</dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="ade088b57ac1fd4a3eca53d7ab364e002"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comparison operator, between two <a class="el" href="classost_1_1_map_index.html" title="The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retri...">MapIndex</a>'s. </p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed. </dd></dl>
</div>
</div>
<a class="anchor" id="a3c4399bd0a54ffeac890c2f7040d0b71"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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 elements being retri...">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 a MapTable...">MapObject</a>, useful to avoid casts for sake of clearness. </p>
<dl class="section return"><dt>Returns</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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
