help/info/enum2int.html

   1 <!--
   2  Copyright (c) 2000-2016 Ericsson Telecom AB
   3  All rights reserved. This program and the accompanying materials
   4  are made available under the terms of the Eclipse Public License v1.0
   5  which accompanies this distribution, and is available at
   6  http://www.eclipse.org/legal/epl-v10.html
   7
   8  Contributors:
   9   Balasko, Jeno
  10 -->
  11 <html>
  12 <head>
  13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  14 <meta http-equiv="Content-Language" content="en-us">
  15 <title>enum2int</title>
  16 </head>
  17 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  18 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  19   <tr>
  20     <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>
  21   </tr>
  22 </table>
  23 <table border="0" align="right" cellpadding="0" cellspacing="0">
  24   <tr>
  25     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  26     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  27     <td><a alt="previous" href="encvalue.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  28     <td><a alt="next" href="enumerated.html"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  29   </tr>
  30 </table>
  31 <p><br clear="all">
  32 </p>
  33 <hr>
  34 <h1>enum2int</h1>
  35 <hr align="left" width="75%"/>
  36 <p>This function converts an <b><font face="Courier New">enumerated</font></b> value into an <b><font face="Courier New">integer</font></b> value associated to the enumerated value.
  37 <hr align="left" width="50%"/>
  38 <p>Related keyword:</p>
  39 <ul>
  40   <li><b><font face="Courier New" size="4" color="#003258"> <a href="integer.html">integer</a></font></b></li>
  41   <li><b><a href="enumerated.html"><font face="Courier New" size="4" color="#003258">enumerated</font></a></b></li>
  42 </ul>
  43 <hr align="left" width="50%">
  44 <div align="center">
  45 <center>
  46 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  47   <tr>
  48     <td width="100%">
  49     <h3 align="center">
  50       <font face="Courier New" color="#003258" size="5"><b>enum2int(in Enumerated_type inpar) return integer</b></font>
  51     </h3>
  52
  53     </td>
  54   </tr>
  55 </table>
  56 </center>
  57 </div>
  58 <ul>
  59   <li>
  60   <p>The actual parameter passed to inpar always shall be a typed object.</p>
  61   </li>
  62 </ul>
  63 <hr align="left" width="25%"/>
  64
  65 <p>Example:</p>
  66 <p>
  67         <font face="Courier New">
  68                 type enumerated MyFirstEnumType { <br/>
  69                         &nbsp;&nbsp;&nbsp;Monday, Tuesday, Wednesday, Thursday, Friday<br/>
  70                 };<br/>
  71     <br/>
  72                 type enumerated MySecondEnumType {<br/>
  73                         &nbsp;&nbsp;&nbsp;Saturday(-3), Sunday (0), Monday<br/>
  74                 };<br/><br/>
  75                 //within a dynamic language element:<br/>
  76                 var MyFirstEnumType vl_FirstEnum := Monday;<br/>
  77                 var MySecondEnumType vl_SecondEnum := Monday;<br/>
  78                 <br/>
  79                 enum2int(vl_FirstEnum) // returns 0<br/>
  80                 enum2int(vl_SecondEnum) // returns 1<br/>
  81                 <br/>
  82                 vl_FirstEnum := Wednesday;<br/>
  83                 vl_SecondEnum := Saturday;<br/>
  84                 enum2int(vl_FirstEnum) // returns 2<br/>
  85                 enum2int(vl_SecondEnum) // returns -3<br/>
  86                 <br/>
  87                 vl_FirstEnum := Friday;<br/>
  88                 vl_SecondEnum := Sunday;<br/>
  89                 enum2int(vl_FirstEnum) // returns 4<br/>
  90                 enum2int(vl_SecondEnum) // returns 0<br/>
  91         </font>
  92 </p>
  93
  94 <hr align="left" width="25%"/>
  95 </body>
  96 </html>