help/info/enum2int.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>enum2int</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 alt="previous" href="encvalue.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a alt="next" href="enumerated.html"><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>enum2int</h1>
  33 <hr align="left" width="75%"/>
  34 <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.
  35 <hr align="left" width="50%"/>
  36 <p>Related keyword:</p>
  37 <ul>
  38   <li><b><font face="Courier New" size="4" color="#003258"> <a href="integer.html">integer</a></font></b></li>
  39   <li><b><a href="enumerated.html"><font face="Courier New" size="4" color="#003258">enumerated</font></a></b></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">
  48       <font face="Courier New" color="#003258" size="5"><b>enum2int(in Enumerated_type inpar) return integer</b></font>
  49     </h3>
  50
  51     </td>
  52   </tr>
  53 </table>
  54 </center>
  55 </div>
  56 <ul>
  57   <li>
  58   <p>The actual parameter passed to inpar always shall be a typed object.</p>
  59   </li>
  60 </ul>
  61 <hr align="left" width="25%"/>
  62
  63 <p>Example:</p>
  64 <p>
  65         <font face="Courier New">
  66                 type enumerated MyFirstEnumType { <br/>
  67                         &nbsp;&nbsp;&nbsp;Monday, Tuesday, Wednesday, Thursday, Friday<br/>
  68                 };<br/>
  69     <br/>
  70                 type enumerated MySecondEnumType {<br/>
  71                         &nbsp;&nbsp;&nbsp;Saturday(-3), Sunday (0), Monday<br/>
  72                 };<br/><br/>
  73                 //within a dynamic language element:<br/>
  74                 var MyFirstEnumType vl_FirstEnum := Monday;<br/>
  75                 var MySecondEnumType vl_SecondEnum := Monday;<br/>
  76                 <br/>
  77                 enum2int(vl_FirstEnum) // returns 0<br/>
  78                 enum2int(vl_SecondEnum) // returns 1<br/>
  79                 <br/>
  80                 vl_FirstEnum := Wednesday;<br/>
  81                 vl_SecondEnum := Saturday;<br/>
  82                 enum2int(vl_FirstEnum) // returns 2<br/>
  83                 enum2int(vl_SecondEnum) // returns -3<br/>
  84                 <br/>
  85                 vl_FirstEnum := Friday;<br/>
  86                 vl_SecondEnum := Sunday;<br/>
  87                 enum2int(vl_FirstEnum) // returns 4<br/>
  88                 enum2int(vl_SecondEnum) // returns 0<br/>
  89         </font>
  90 </p>
  91
  92 <hr align="left" width="25%"/>
  93 </body>
  94 </html>