classlayer__stack__builder.html 18.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: layer_stack_builder 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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classlayer__stack__builder-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">layer_stack_builder Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class provides a factory class to create Layer class instances.  
garciay's avatar
garciay committed
 <a href="classlayer__stack__builder.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="layer__stack__builder_8hh_source.html">layer_stack_builder.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:a2f46dfd1ceac17a903935f1d9f5ec525"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlayer.html">layer</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#a2f46dfd1ceac17a903935f1d9f5ec525">create_layer_stack</a> (const char *p_layer_stack_description)</td></tr>
<tr class="memdesc:a2f46dfd1ceac17a903935f1d9f5ec525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new layer factory.  <a href="#a2f46dfd1ceac17a903935f1d9f5ec525">More...</a><br /></td></tr>
<tr class="separator:a2f46dfd1ceac17a903935f1d9f5ec525"><td class="memSeparator" colspan="2">&#160;</td></tr>
garciay's avatar
garciay committed
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab9637ef25fe34e8f7a67e9f06986407d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlayer__stack__builder.html">layer_stack_builder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#ab9637ef25fe34e8f7a67e9f06986407d">get_instance</a> ()</td></tr>
<tr class="memdesc:ab9637ef25fe34e8f7a67e9f06986407d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor for the unique instance of the logger framework.  <a href="#ab9637ef25fe34e8f7a67e9f06986407d">More...</a><br /></td></tr>
<tr class="separator:ab9637ef25fe34e8f7a67e9f06986407d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa99a5ea1f37df1a16b1b191b794bbe95"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#aa99a5ea1f37df1a16b1b191b794bbe95">register_layer_factory</a> (const std::string &amp;p_type, <a class="el" href="classlayer__factory.html">layer_factory</a> *p_layer_factory)</td></tr>
<tr class="memdesc:aa99a5ea1f37df1a16b1b191b794bbe95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new layer factory.  <a href="#aa99a5ea1f37df1a16b1b191b794bbe95">More...</a><br /></td></tr>
<tr class="separator:aa99a5ea1f37df1a16b1b191b794bbe95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a9e891ed566ca54156f2dc6b67b63a673"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; std::string, <a class="el" href="classlayer__factory.html">layer_factory</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#a9e891ed566ca54156f2dc6b67b63a673">LayerFactoryMap</a></td></tr>
<tr class="separator:a9e891ed566ca54156f2dc6b67b63a673"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a8b2f281852706bd8e723126e1102c2af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#a8b2f281852706bd8e723126e1102c2af">layer_stack_builder</a> ()</td></tr>
<tr class="memdesc:a8b2f281852706bd8e723126e1102c2af"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of the registered.  <a href="#a8b2f281852706bd8e723126e1102c2af">More...</a><br /></td></tr>
<tr class="separator:a8b2f281852706bd8e723126e1102c2af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4eb9750441959253e1aa206f1ad0410"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#ac4eb9750441959253e1aa206f1ad0410">_register_layer_factory</a> (const std::string &amp;p_type, <a class="el" href="classlayer__factory.html">layer_factory</a> *p_layer_factory)</td></tr>
<tr class="memdesc:ac4eb9750441959253e1aa206f1ad0410"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new layer factory.  <a href="#ac4eb9750441959253e1aa206f1ad0410">More...</a><br /></td></tr>
<tr class="separator:ac4eb9750441959253e1aa206f1ad0410"><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:a4b8f51c3b9735253d4180b72c896346e"><td class="memItemLeft" align="right" valign="top">std::map&lt; std::string, <a class="el" href="classlayer__factory.html">layer_factory</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#a4b8f51c3b9735253d4180b72c896346e">_layer_factories</a></td></tr>
<tr class="memdesc:a4b8f51c3b9735253d4180b72c896346e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart pointer to the unique instance of the logger framework.  <a href="#a4b8f51c3b9735253d4180b72c896346e">More...</a><br /></td></tr>
<tr class="separator:a4b8f51c3b9735253d4180b72c896346e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:a7f29d46260b2a0f342014ead9d60c165"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classlayer__stack__builder.html">layer_stack_builder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlayer__stack__builder.html#a7f29d46260b2a0f342014ead9d60c165">_instance</a> = NULL</td></tr>
<tr class="separator:a7f29d46260b2a0f342014ead9d60c165"><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 a factory class to create Layer class instances. </p>
garciay's avatar
garciay committed
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a9e891ed566ca54156f2dc6b67b63a673"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e891ed566ca54156f2dc6b67b63a673">&#9670;&nbsp;</a></span>LayerFactoryMap</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::map&lt;std::string, <a class="el" href="classlayer__factory.html">layer_factory</a>*&gt; <a class="el" href="classlayer__stack__builder.html#a9e891ed566ca54156f2dc6b67b63a673">layer_stack_builder::LayerFactoryMap</a></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>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8b2f281852706bd8e723126e1102c2af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b2f281852706bd8e723126e1102c2af">&#9670;&nbsp;</a></span>layer_stack_builder()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">layer_stack_builder::layer_stack_builder </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The list of the registered. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classt__layer.html" title="This class provides basic description of an ITS port protocol layer. A port protocol layer is the fin...">t_layer</a> factories</dd></dl>
garciay's avatar
garciay committed
<p>Default constructor Create a new instance of the <a class="el" href="classlayer__stack__builder.html" title="This class provides a factory class to create Layer class instances. ">layer_stack_builder</a> class </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void layer_stack_builder::_register_layer_factory </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>p_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classlayer__factory.html">layer_factory</a> *&#160;</td>
          <td class="paramname"><em>p_layer_factory</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add a new layer factory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_type</td><td>The layer identifier (e.g. GN for the GeoNetworking layer...) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_layer_factory</td><td>A reference to the </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classlayer__factory.html" title="This class provides a factory class to create layer class instances . ">layer_factory</a> </dd></dl>
garciay's avatar
garciay committed

</div>
</div>
<a id="a2f46dfd1ceac17a903935f1d9f5ec525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f46dfd1ceac17a903935f1d9f5ec525">&#9670;&nbsp;</a></span>create_layer_stack()</h2>
garciay's avatar
garciay committed

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classlayer.html">layer</a> * layer_stack_builder::create_layer_stack </td>
garciay's avatar
garciay committed
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>p_layer_stack_description</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a new layer factory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_layer_stack_description</td><td>A textual description of the layer to create </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The created layer object on success, nullptr otherwise </dd></dl>

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

<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="classlayer__stack__builder.html">layer_stack_builder</a> * layer_stack_builder::get_instance </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Accessor for the unique instance of the logger framework. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void layer_stack_builder::register_layer_factory </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>p_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classlayer__factory.html">layer_factory</a> *&#160;</td>
          <td class="paramname"><em>p_layer_factory</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Add a new layer factory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_type</td><td>The layer identifier (e.g. GN for the GeoNetworking layer...) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_layer_factory</td><td>A reference to the </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classlayer__factory.html" title="This class provides a factory class to create layer class instances . ">layer_factory</a>  </dd></dl>
garciay's avatar
garciay committed

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

<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="classlayer__stack__builder.html">layer_stack_builder</a> * layer_stack_builder::_instance = NULL</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a4b8f51c3b9735253d4180b72c896346e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b8f51c3b9735253d4180b72c896346e">&#9670;&nbsp;</a></span>_layer_factories</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;std::string, <a class="el" href="classlayer__factory.html">layer_factory</a>*&gt; layer_stack_builder::_layer_factories</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Smart pointer to the unique instance of the logger framework. </p>

</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="layer__stack__builder_8hh_source.html">layer_stack_builder.hh</a></li>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/src/<a class="el" href="layer__factory_8cc.html">layer_factory.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>