help/info/isbound.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>isbound</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="interleave.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a alt="next" href="ischosen.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>isbound</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 template parameter is completely initialized, thus, contains only concrete or omitted values,
  35 with the following exception: isbound returns true for a record-of value which contains both bound and unbound elements, whereas <a href="isvalue.html">isvalue</a> returns false.
  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><font face="Courier New" size="4" color="#003258"><a href="false.html"> false</a></font></b></li>
  42   <li><b><font face="Courier New" size="4" color="#003258"> <a href="template.html">template</a></font></b></li>
  43   <li><b><font face="Courier New" size="4" color="#003258"> <a href="omit.html">omit</a></font></b></li>
  44 </ul>
  45 <hr align="left" width="50%">
  46 <div align="center">
  47 <center>
  48 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  49   <tr>
  50     <td width="100%">
  51     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>isbound</b></font> <font face="Courier New" color="#003258" size="5"><b> (</b></font><i>in template any_type
  52     inparameter</i><font face="Courier New" color="#003258" size="5"><b>)return boolean</b></font></h3>
  53     </td>
  54   </tr>
  55 </table>
  56 </center>
  57 </div>
  58 <hr align="left" width="25%">
  59 <p>Example 1:</p>
  60 <p><font face="Courier New">type record&nbsp; MyRecordType {&nbsp;<br>
  61 &nbsp;&nbsp;&nbsp;integer field1 optional,<br>
  62 &nbsp;&nbsp;&nbsp;integer field2 optional<br>
  63 }<br>
  64 ...</font></p>
  65 <p><font face="Courier New">var MyRecordType v_MyRecord;<br>
  66 var template MyRecordType vt_MyRecordTemplate;<br>
  67 ...</font></p>
  68 <p><font face="Courier New">isbound(v_MyRecord); // return false<br>
  69 isbound(vt_MyRecordTemplate); // return false<br>
  70 ...</font></p>
  71 <p><font face="Courier New">v_MyRecord := { field1 := 5, field2 := omit}<br>
  72 vt_MyRecordTemplate := { field1 := ?, field2 := 5}<br>
  73 ...</font></p>
  74 <p><font face="Courier New">isbound(v_MyRecord); // return true<br>
  75 isbound(v_MyRecord.field2); // return false<br>
  76 isbound(vt_MyRecordTemplate); // return false<br>
  77 isbound(vt_MyRecordTemplate.field1); // return false<br>
  78 isbound(vt_MyRecordTemplate.field2); // return true<br>
  79 </font></p>
  80 <hr align="left" width="25%">
  81 </body>
  82 </html>