help/info/decvalue.html

   1 <!--
   2  Copyright (c) 2000-2014 Ericsson Telecom AB
   3
   4  All rights reserved. This program and the accompanying materials
   5  are made available under the terms of the Eclipse Public License v1.0
   6  which accompanies this distribution, and is available at
   7  http://www.eclipse.org/legal/epl-v10.html
   8  -->
   9 <html>
  10 <head>
  11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  12 <meta http-equiv="Content-Language" content="en-us">
  13 <title>decvalue</title>
  14 </head>
  15 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  16 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  17   <tr>
  18     <td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td>
  19   </tr>
  20 </table>
  21 <table border="0" align="right" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  24     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  25     <td><a href="decode_base64.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="default.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  27   </tr>
  28 </table>
  29 <p><br clear="all">
  30 </p>
  31 <hr>
  32 <h1>decvalue</h1>
  33 <hr align="left" width="75%">
  34 <p>This built-in function decodes a value from a bitstring and cuts the consumed part from the bitstring.
  35 <ul>
  36   <li>The function return type is integer holding the error code: <b>0</b> - decoding was successful, <b>1</b> - unspecified cause of decoding failure, <b>2</b> - decoding failed because the
  37   bitstring did not contained enough bits.</li>
  38   <li>Decoded value returned through the second (out) argument.</li>
  39   <li>Type of the second argument has to have an <i>encoding method</i> explicitly set with its atributes.</li>
  40 </ul>
  41 <p>Related keywords:</p>
  42 <ul>
  43   <li><a href="encode.html"><b><font face="Courier New" color="#003258" size="4">encode</font></b></a></li>
  44   <li><a href="encvalue.html"><b><font face="Courier New" color="#003258" size="4">encvalue</font></b></a></li>
  45 </ul>
  46 <hr align="left" width="50%">
  47 <div align="center">
  48 <center>
  49 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  50   <tr>
  51     <td width="100%">
  52     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>decvalue(</b></font> <i>inout bitstring_value, out decoded_value</i> <font face="Courier New" color="#003258" size="5"><b>)
  53     return integer;</b></font></h3>
  54     </td>
  55   </tr>
  56 </table>
  57 </center>
  58 </div>
  59 <hr align="left" width="50%">
  60 <p>Example:
  61 <p><font face="Courier New">type float MyFloat with { encode "RAW" }</font>
  62 <p><font face="Courier New">var MyFloat f := 1.1;</font>
  63 <p><font face="Courier New">var bitstring bs := encvalue(f);</font>
  64 <p><font face="Courier New">var integer i := decvalue(bs, f);</font>
  65 <hr align="left" width="25%">
  66 <hr align="left" width="25%">
  67 <p><a HREF="BNF.html#decvalue">BNF definition</a> of <font face="Courier New">decvalue</font></p>
  68 </body>
  69 </html>