help/info/encode.html

   1 <!--
   2  Copyright (c) 2000-2015 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>encode</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="else.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="encode_base64.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>encode</h1>
  33 <hr align="left" width="75%">
  34 <p>The attribute allows the association of some referenced encoding rule or encoding directive to be made to a TTCN-3 definition. The syntax for the argument of the statement (i.e. the actual
  35 attributes) is defined as a free text string.
  36 <p>Related keywords:</p>
  37 <ul>
  38   <li><a href="with.html"><b><font face="Courier New" color="#003258" size="4">with</font></b></a></li>
  39   <li><a href="override.html"><b><font face="Courier New" color="#003258" size="4">override</font></b></a></li>
  40 </ul>
  41 <hr align="left" width="50%">
  42 <div align="center">
  43 <center>
  44 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  45   <tr>
  46     <td width="100%">
  47     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>encode</b></font> [ <font face="Courier New" color="#003258" size="5"><b>override</b></font> ] [ <font
  48       face="Courier New" color="#003258" size="5"><b>(</b></font><i>qualifier</i><font face="Courier New" color="#003258" size="5"><b>)</b></font> ] <font face="Courier New" color="#003258" size="5"><b>&quot;</b></font><i>argument</i><b><font
  49       face="Courier New" color="#003258" size="5">&quot;</font></b></h3>
  50     </td>
  51   </tr>
  52 </table>
  53 </center>
  54 </div>
  55 <ul>
  56   <li>
  57   <p>the optional <b><font face="Courier New">override</font></b> directive forces all contained types at all lower scopes to be forced to the specified attribute.</p>
  58   </li>
  59   <li>
  60   <p>the optional <i>qualifier</i> points out the entity for which the argument is valid.</p>
  61   </li>
  62   <li>
  63   <p><i>argument</i> is a free-text string specifying the actual attribute. TITAN defines attributes RAW and TEXT for encoding TTCN-3 type definitions.</p>
  64   </li>
  65 </ul>
  66 <hr align="left" width="50%">
  67 <p>Example:</p>
  68 <code> module MyModule {<BR>
  69 /* Imagine module body here */<BR>
  70 } with { encode "RAW" }<BR>
  71 </code>
  72 <p>Type definitions within MyModule are to be encoded using TITAN RAW encoder/decoder.
  73 <hr align="left" width="25%">
  74 <hr align="left" width="25%">
  75 <p><a HREF="BNF.html#attribkeyword">BNF definition</a> of <font face="Courier New"> encode</font></p>
  76 </body>
  77 </html>