help/info/ischosen.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>ischosen</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="isbound.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a alt="next" href="ispresent.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>ischosen</h1>
  33 <hr align="left" width="75%">
  34 <p>This function returns the value <b><font face="Courier New">true</font></b> if and only if the data object reference specifies the variant of the <b><font face="Courier New">union</font></b>
  35 type that is actually selected for a given data object.
  36 <hr align="left" width="50%">
  37 <p>Related keyword:</p>
  38 <ul>
  39   <li><b><font face="Courier New" size="4" color="#003258"><a href="boolean.html">boolean</a></font></b></li>
  40   <li><b><a href="true.html"><font face="Courier New" size="4" color="#003258">true</font></a></b></li>
  41   <li><b><a href="false.html"><font face="Courier New" size="4" color="#003258">false</font></a></b></li>
  42   <li><b><a href="union.html"><font face="Courier New" size="4" color="#003258">union</font></a></b></li>
  43 </ul>
  44 <hr align="left" width="50%">
  45 <div align="center">
  46 <center>
  47 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  48   <tr>
  49     <td width="100%">
  50     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>ischosen</b></font><font face="Courier New" color="#003258" size="5"><b>(</b></font><i>any_type value</i><font
  51       face="Courier New" color="#003258" size="5"><b>) return boolean</b></font></h3>
  52     </td>
  53   </tr>
  54 </table>
  55 </center>
  56 </div>
  57 <ul>
  58 </ul>
  59 <hr align="left" width="25%">
  60 <p>Example 1:</p>
  61 <p><font face="Courier New"> &nbsp;&nbsp;type union MyUnion<br>
  62 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;&nbsp;PDU_type1&nbsp;p1,<br>
  63 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PDU_type2&nbsp;p2,<br>
  64 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PDU_type&nbsp;p3<br>
  65 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>
  66 <br>
  67 <p>...
  68 <p>&nbsp;&nbsp;// and given that MyPDU is a template of MyUnion type<br>
  69 &nbsp;&nbsp;// and received_PDU is also of MyUnion type <br>
  70 &nbsp;&nbsp;// then <br>
  71 &nbsp;&nbsp;MyPort.receive(MyPDU) -> value received_PDU<br>
  72 <br>
  73 &nbsp;&nbsp;ischosen(received_PDU.p2)<br>
  74 &nbsp;&nbsp;// returns true if the actual instance of MyPDU carries a PDU of the type PDU_type2
  75 </font></p>
  76 <hr align="left" width="25%">
  77 </body>
  78 </html>