Codec_8hh_source.html 9.41 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: /home/vagrant/TriesAndDelete/etsi_its/framework/include/Codec.hh Source File</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_644e041c3a6521da7b27eba0e4eb2b95.html">framework</a></li><li class="navelem"><a class="el" href="dir_dd40116cd1cfebdc77a7c7114b29912e.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Codec.hh</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Codec_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Params_8hh.html">Params.hh</a>&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">class </span>OCTETSTRING; </div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">class </span>CHARSTRING;  </div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">class </span>BITSTRING;   </div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> TPDUEnc, <span class="keyword">typename</span> TPDUDec&gt;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classCodec.html">   25</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCodec.html">Codec</a></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;{</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classCodec.html#ab0091617de01a9dc2b3157104524c7cf">   28</a></span>&#160;  <a class="code" href="classParams.html">Params</a>* <a class="code" href="classCodec.html#ab0091617de01a9dc2b3157104524c7cf">_params</a>; </div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;                   <span class="comment">// \todo Use smart pointer std::unique_ptr&lt;Params&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;  </div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">public</span>: </div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classCodec.html#a6cc0ac28c9456ff2227948fde0f5ef42">   37</a></span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classCodec.html#a6cc0ac28c9456ff2227948fde0f5ef42">Codec</a>() : _params(nullptr) { };</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classCodec.html#acc7e5a08cde71f14c71be8bb5f00ead7">   44</a></span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classCodec.html#acc7e5a08cde71f14c71be8bb5f00ead7">~Codec</a>() { };</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCodec.html#a0be3395b2210100134f6fad1aa668040">encode</a>(<span class="keyword">const</span> TPDUEnc&amp; p_message, OCTETSTRING&amp; p_data) = 0;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCodec.html#ad2fcf979f48f76b4aed0193e21336469">decode</a>(<span class="keyword">const</span> OCTETSTRING&amp; p_, TPDUDec&amp; p_message, <a class="code" href="classParams.html">Params</a>* p_params = NULL) = 0;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;}; <span class="comment">// End of class Codec</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="ttc" id="classCodec_html_ab0091617de01a9dc2b3157104524c7cf"><div class="ttname"><a href="classCodec.html#ab0091617de01a9dc2b3157104524c7cf">Codec::_params</a></div><div class="ttdeci">Params * _params</div><div class="ttdef"><b>Definition:</b> Codec.hh:28</div></div>
<div class="ttc" id="classCodec_html_a6cc0ac28c9456ff2227948fde0f5ef42"><div class="ttname"><a href="classCodec.html#a6cc0ac28c9456ff2227948fde0f5ef42">Codec::Codec</a></div><div class="ttdeci">Codec()</div><div class="ttdoc">Reference to Params stack. </div><div class="ttdef"><b>Definition:</b> Codec.hh:37</div></div>
<div class="ttc" id="classCodec_html_ad2fcf979f48f76b4aed0193e21336469"><div class="ttname"><a href="classCodec.html#ad2fcf979f48f76b4aed0193e21336469">Codec::decode</a></div><div class="ttdeci">virtual int decode(const OCTETSTRING &amp;p_, TPDUDec &amp;p_message, Params *p_params=NULL)=0</div><div class="ttdoc">Encode typed message into an octet string format. </div></div>
<div class="ttc" id="Params_8hh_html"><div class="ttname"><a href="Params_8hh.html">Params.hh</a></div><div class="ttdoc">Header file for the parameter dictionary. </div></div>
<div class="ttc" id="classCodec_html"><div class="ttname"><a href="classCodec.html">Codec</a></div><div class="ttdoc">Declare TITAN class. </div><div class="ttdef"><b>Definition:</b> Codec.hh:25</div></div>
<div class="ttc" id="classParams_html"><div class="ttname"><a href="classParams.html">Params</a></div><div class="ttdoc">This class provides basic functionalities for an ITS dictionary. </div><div class="ttdef"><b>Definition:</b> Params.hh:21</div></div>
<div class="ttc" id="classCodec_html_acc7e5a08cde71f14c71be8bb5f00ead7"><div class="ttname"><a href="classCodec.html#acc7e5a08cde71f14c71be8bb5f00ead7">Codec::~Codec</a></div><div class="ttdeci">virtual ~Codec()</div><div class="ttdoc">Default destructor . </div><div class="ttdef"><b>Definition:</b> Codec.hh:44</div></div>
<div class="ttc" id="classCodec_html_a0be3395b2210100134f6fad1aa668040"><div class="ttname"><a href="classCodec.html#a0be3395b2210100134f6fad1aa668040">Codec::encode</a></div><div class="ttdeci">virtual int encode(const TPDUEnc &amp;p_message, OCTETSTRING &amp;p_data)=0</div><div class="ttdoc">Encode typed message into an octet string. </div><div class="ttdef"><b>Definition:</b> Codec.hh:44</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 4 2018 14:16:23 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>