classlocation__table.html 16.8 KB
Newer Older
garciay's avatar
garciay committed
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ETSI STF525 / Internal Testing test suite: location_table 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ETSI STF525 / Internal Testing test suite
   </div>
   <div id="projectbrief">This project provides an internal testing test suite and its associated Test Adapter/Codec</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classlocation__table-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">location_table Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class provides description of GeoNetworking table.  
 <a href="classlocation__table.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="location__table_8hh_source.html">location_table.hh</a>&gt;</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:a5741938d15d192c0d68d0e8b2dbedc34"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#a5741938d15d192c0d68d0e8b2dbedc34">location_table</a> ()</td></tr>
<tr class="memdesc:a5741938d15d192c0d68d0e8b2dbedc34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a5741938d15d192c0d68d0e8b2dbedc34">More...</a><br /></td></tr>
<tr class="separator:a5741938d15d192c0d68d0e8b2dbedc34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0980f4cb9e594b06d92516e9f760628e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#a0980f4cb9e594b06d92516e9f760628e">~location_table</a> ()</td></tr>
<tr class="memdesc:a0980f4cb9e594b06d92516e9f760628e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a0980f4cb9e594b06d92516e9f760628e">More...</a><br /></td></tr>
<tr class="separator:a0980f4cb9e594b06d92516e9f760628e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9a651d5503c2aa4f398d011f1825eee"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#aa9a651d5503c2aa4f398d011f1825eee">has_entry</a> (const OCTETSTRING &amp;p_mid) const</td></tr>
<tr class="memdesc:aa9a651d5503c2aa4f398d011f1825eee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates if the GeoNetworking MID is present in the table.  <a href="#aa9a651d5503c2aa4f398d011f1825eee">More...</a><br /></td></tr>
<tr class="separator:aa9a651d5503c2aa4f398d011f1825eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c979a2a025039cda281392849ecbaf7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#a7c979a2a025039cda281392849ecbaf7">add_entry</a> (const LibItsGeoNetworking__TypesAndValues::LongPosVector &amp;p_long_pos_vector)</td></tr>
<tr class="memdesc:a7c979a2a025039cda281392849ecbaf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new item in the location table.  <a href="#a7c979a2a025039cda281392849ecbaf7">More...</a><br /></td></tr>
<tr class="separator:a7c979a2a025039cda281392849ecbaf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad65a8b70b1f699bb70df86ca56616bbb"><td class="memItemLeft" align="right" valign="top">const LibItsGeoNetworking__TypesAndValues::LongPosVector *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#ad65a8b70b1f699bb70df86ca56616bbb">get_entry</a> (const OCTETSTRING &amp;p_mid) const</td></tr>
<tr class="memdesc:ad65a8b70b1f699bb70df86ca56616bbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve an item from the location table based on the GeoNetworking MID.  <a href="#ad65a8b70b1f699bb70df86ca56616bbb">More...</a><br /></td></tr>
<tr class="separator:ad65a8b70b1f699bb70df86ca56616bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6453ec438f79427d251f500c9b6a92a"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#ac6453ec438f79427d251f500c9b6a92a">empty</a> () const</td></tr>
<tr class="memdesc:ac6453ec438f79427d251f500c9b6a92a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates if the table is empty.  <a href="#ac6453ec438f79427d251f500c9b6a92a">More...</a><br /></td></tr>
<tr class="separator:ac6453ec438f79427d251f500c9b6a92a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a346324a7e626919232625743cade8d57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#a346324a7e626919232625743cade8d57">reset</a> ()</td></tr>
<tr class="memdesc:a346324a7e626919232625743cade8d57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Purge the location table.  <a href="#a346324a7e626919232625743cade8d57">More...</a><br /></td></tr>
<tr class="separator:a346324a7e626919232625743cade8d57"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a67078ead032a6fa8ff4049e35462bae0"><td class="memItemLeft" align="right" valign="top">std::map&lt; const unsigned long, std::shared_ptr&lt; LibItsGeoNetworking__TypesAndValues::LongPosVector &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#a67078ead032a6fa8ff4049e35462bae0">_entries_by_times</a></td></tr>
<tr class="separator:a67078ead032a6fa8ff4049e35462bae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac22fe53a353073d7fd09ea24eaabd25f"><td class="memItemLeft" align="right" valign="top">std::map&lt; const std::string, std::shared_ptr&lt; LibItsGeoNetworking__TypesAndValues::LongPosVector &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation__table.html#ac22fe53a353073d7fd09ea24eaabd25f">_entries_by_mids</a></td></tr>
<tr class="separator:ac22fe53a353073d7fd09ea24eaabd25f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides description of GeoNetworking table. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000025">Todo:</a></b></dt><dd><p class="startdd">Add time expired removal procedure </p>
garciay's avatar
garciay committed
<p class="enddd">Add reference to the GeoNetworking ETSI standard </p>
</dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5741938d15d192c0d68d0e8b2dbedc34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5741938d15d192c0d68d0e8b2dbedc34">&#9670;&nbsp;</a></span>location_table()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">location_table::location_table </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 class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a id="a0980f4cb9e594b06d92516e9f760628e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0980f4cb9e594b06d92516e9f760628e">&#9670;&nbsp;</a></span>~location_table()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual location_table::~location_table </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 class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7c979a2a025039cda281392849ecbaf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c979a2a025039cda281392849ecbaf7">&#9670;&nbsp;</a></span>add_entry()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void location_table::add_entry </td>
          <td>(</td>
          <td class="paramtype">const LibItsGeoNetworking__TypesAndValues::LongPosVector &amp;&#160;</td>
          <td class="paramname"><em>p_long_pos_vector</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a new item in the location table. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_long_pos_vector</td><td>The new long position vector to add </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ac6453ec438f79427d251f500c9b6a92a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6453ec438f79427d251f500c9b6a92a">&#9670;&nbsp;</a></span>empty()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const bool location_table::empty </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>Indicates if the table is empty. </p>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise </dd></dl>

</div>
</div>
<a id="ad65a8b70b1f699bb70df86ca56616bbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad65a8b70b1f699bb70df86ca56616bbb">&#9670;&nbsp;</a></span>get_entry()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const LibItsGeoNetworking__TypesAndValues::LongPosVector * location_table::get_entry </td>
          <td>(</td>
          <td class="paramtype">const OCTETSTRING &amp;&#160;</td>
          <td class="paramname"><em>p_mid</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve an item from the location table based on the GeoNetworking MID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_mid</td><td>The GeoNetworking MID </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa9a651d5503c2aa4f398d011f1825eee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9a651d5503c2aa4f398d011f1825eee">&#9670;&nbsp;</a></span>has_entry()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const bool location_table::has_entry </td>
          <td>(</td>
          <td class="paramtype">const OCTETSTRING &amp;&#160;</td>
          <td class="paramname"><em>p_mid</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indicates if the GeoNetworking MID is present in the table. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_mid</td><td>The GeoNetworking MID </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false otherwise </dd></dl>

</div>
</div>
<a id="a346324a7e626919232625743cade8d57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a346324a7e626919232625743cade8d57">&#9670;&nbsp;</a></span>reset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void location_table::reset </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>Purge the location table. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac22fe53a353073d7fd09ea24eaabd25f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac22fe53a353073d7fd09ea24eaabd25f">&#9670;&nbsp;</a></span>_entries_by_mids</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::map&lt;const std::string, std::shared_ptr&lt;LibItsGeoNetworking__TypesAndValues::LongPosVector&gt; &gt; location_table::_entries_by_mids</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a67078ead032a6fa8ff4049e35462bae0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67078ead032a6fa8ff4049e35462bae0">&#9670;&nbsp;</a></span>_entries_by_times</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::map&lt;const unsigned long, std::shared_ptr&lt;LibItsGeoNetworking__TypesAndValues::LongPosVector&gt; &gt; location_table::_entries_by_times</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/include/<a class="el" href="location__table_8hh_source.html">location_table.hh</a></li>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/src/<a class="el" href="location__table_8cc.html">location_table.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:33 for ETSI STF525 / Internal Testing test suite by &#160;<a href="http://www.doxygen.org/index.html">
garciay's avatar
garciay committed
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>