classIVIMCodec.html 15.1 KB
Newer Older
garciay's avatar
garciay committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
<!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: IVIMCodec 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="classIVIMCodec-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">IVIMCodec Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="IVIMCodec_8hh_source.html">IVIMCodec.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IVIMCodec:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classIVIMCodec.png" usemap="#IVIMCodec_map" alt=""/>
  <map id="IVIMCodec_map" name="IVIMCodec_map">
<area href="classCodec.html" alt="Codec&lt; IVIM__PDU__Descriptions::IVIM, IVIM__PDU__Descriptions::IVIM &gt;" shape="rect" coords="0,0,444,24"/>
</map>
 </div></div>
<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:a3f7a5c872d8310763edea852319bebf4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIVIMCodec.html#a3f7a5c872d8310763edea852319bebf4">IVIMCodec</a> ()</td></tr>
<tr class="separator:a3f7a5c872d8310763edea852319bebf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbda2a1026a883e361dd3c32515306af"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIVIMCodec.html#adbda2a1026a883e361dd3c32515306af">~IVIMCodec</a> ()</td></tr>
<tr class="separator:adbda2a1026a883e361dd3c32515306af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1a8b745e39830de4af40b3d0834af19"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIVIMCodec.html#ac1a8b745e39830de4af40b3d0834af19">encode</a> (const IVIM__PDU__Descriptions::IVIM &amp;ivim, OCTETSTRING &amp;data)</td></tr>
<tr class="memdesc:ac1a8b745e39830de4af40b3d0834af19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode typed message into an octet string.  <a href="#ac1a8b745e39830de4af40b3d0834af19">More...</a><br /></td></tr>
<tr class="separator:ac1a8b745e39830de4af40b3d0834af19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf878094202d4cbcd8aab59e463bed00"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIVIMCodec.html#aaf878094202d4cbcd8aab59e463bed00">decode</a> (const OCTETSTRING &amp;data, IVIM__PDU__Descriptions::IVIM &amp;, <a class="el" href="classParams.html">Params</a> *params=NULL)</td></tr>
<tr class="memdesc:aaf878094202d4cbcd8aab59e463bed00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode typed message into an octet string format.  <a href="#aaf878094202d4cbcd8aab59e463bed00">More...</a><br /></td></tr>
<tr class="separator:aaf878094202d4cbcd8aab59e463bed00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCodec"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCodec')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCodec.html">Codec&lt; IVIM__PDU__Descriptions::IVIM, IVIM__PDU__Descriptions::IVIM &gt;</a></td></tr>
<tr class="memitem:a6cc0ac28c9456ff2227948fde0f5ef42 inherit pub_methods_classCodec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCodec.html#a6cc0ac28c9456ff2227948fde0f5ef42">Codec</a> ()</td></tr>
<tr class="memdesc:a6cc0ac28c9456ff2227948fde0f5ef42 inherit pub_methods_classCodec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to <a class="el" href="classParams.html" title="This class provides basic functionalities for an ITS dictionary. ">Params</a> stack.  <a href="classCodec.html#a6cc0ac28c9456ff2227948fde0f5ef42">More...</a><br /></td></tr>
<tr class="separator:a6cc0ac28c9456ff2227948fde0f5ef42 inherit pub_methods_classCodec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc7e5a08cde71f14c71be8bb5f00ead7 inherit pub_methods_classCodec"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCodec.html#acc7e5a08cde71f14c71be8bb5f00ead7">~Codec</a> ()</td></tr>
<tr class="memdesc:acc7e5a08cde71f14c71be8bb5f00ead7 inherit pub_methods_classCodec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor .  <a href="classCodec.html#acc7e5a08cde71f14c71be8bb5f00ead7">More...</a><br /></td></tr>
<tr class="separator:acc7e5a08cde71f14c71be8bb5f00ead7 inherit pub_methods_classCodec"><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:aa3dcc40c5a4bcaff82182aaf2850f15f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIVIMPDUCodec.html">IVIMPDUCodec</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIVIMCodec.html#aa3dcc40c5a4bcaff82182aaf2850f15f">asnCodec</a></td></tr>
<tr class="separator:aa3dcc40c5a4bcaff82182aaf2850f15f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classCodec"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classCodec')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classCodec.html">Codec&lt; IVIM__PDU__Descriptions::IVIM, IVIM__PDU__Descriptions::IVIM &gt;</a></td></tr>
<tr class="memitem:ab0091617de01a9dc2b3157104524c7cf inherit pro_attribs_classCodec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classParams.html">Params</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCodec.html#ab0091617de01a9dc2b3157104524c7cf">_params</a></td></tr>
<tr class="separator:ab0091617de01a9dc2b3157104524c7cf inherit pro_attribs_classCodec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3f7a5c872d8310763edea852319bebf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f7a5c872d8310763edea852319bebf4">&#9670;&nbsp;</a></span>IVIMCodec()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">IVIMCodec::IVIMCodec </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">

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

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

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int IVIMCodec::decode </td>
          <td>(</td>
          <td class="paramtype">const OCTETSTRING &amp;&#160;</td>
          <td class="paramname"><em>p_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IVIM__PDU__Descriptions::IVIM &amp;&#160;</td>
          <td class="paramname"><em>p_message</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classParams.html">Params</a> *&#160;</td>
          <td class="paramname"><em>p_params</em> = <code>NULL</code>&#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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode typed message into an octet string format. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_data</td><td>The message in its octet string </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">p_message</td><td>The decoded typed message </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise  </dd></dl>

<p>Implements <a class="el" href="classCodec.html#ad2fcf979f48f76b4aed0193e21336469">Codec&lt; IVIM__PDU__Descriptions::IVIM, IVIM__PDU__Descriptions::IVIM &gt;</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int IVIMCodec::encode </td>
          <td>(</td>
          <td class="paramtype">const IVIM__PDU__Descriptions::IVIM &amp;&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">OCTETSTRING &amp;&#160;</td>
          <td class="paramname"><em>data</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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode typed message into an octet string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_message</td><td>The typed message to be encoded </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">p_data</td><td>The encoding result </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise  </dd></dl>

<p>Implements <a class="el" href="classCodec.html#a0be3395b2210100134f6fad1aa668040">Codec&lt; IVIM__PDU__Descriptions::IVIM, IVIM__PDU__Descriptions::IVIM &gt;</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa3dcc40c5a4bcaff82182aaf2850f15f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3dcc40c5a4bcaff82182aaf2850f15f">&#9670;&nbsp;</a></span>asnCodec</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="classIVIMPDUCodec.html">IVIMPDUCodec</a> IVIMCodec::asnCodec</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="IVIMCodec_8hh_source.html">IVIMCodec.hh</a></li>
<li>/home/vagrant/TriesAndDelete/etsi_its/framework/src/<a class="el" href="IVIMCodec_8cc.html">IVIMCodec.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
297
Generated on Wed Apr 4 2018 14:16:32 for ETSI STF525 / Internal Testing test suite by &#160;<a href="http://www.doxygen.org/index.html">
garciay's avatar
garciay committed
298 299 300 301 302
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>