help/info/match.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>match</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="map.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="message.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>match</h1>
  33 <hr align="left" width="75%">
  34 <p>The operation belongs to the family of predefined functions operating on templates. It allows the value of a variable or parameter to be compared with a template (it can be interpreted as an
  35 extended 'equality' operation). The operation returns a Boolean value.&nbsp;
  36 <ul>
  37   <li>If the types of the template and variable are not compatible the operation returns false.&nbsp;</li>
  38   <li>If the types are compatible the return value of the operation indicates whether the value of the variable conforms to the specified template.</li>
  39 </ul>
  40 <hr align="left" width="50%">
  41 <p>Related keyword:</p>
  42 <ul>
  43   <li><a href="template.html"><b><font face="Courier New" color="#003258" size="4">template</font></b></a></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>match (</b></font><i>value</i><font face="Courier New" color="#003258" size="5"><b>,</b></font><i>&nbsp;template_instance</i><font
  52       face="Courier New" color="#003258" size="5"><b>)</b></font></h3>
  53     </td>
  54   </tr>
  55 </table>
  56 </center>
  57 </div>
  58 <ul>
  59   <li>
  60   <p>The&nbsp; <font face="Courier New" color="#003258" size="4"><b>match</b></font> keyword introduces the operation.</p>
  61   </li>
  62   <li>
  63   <p><i>value</i> a variable or a parameter that will be compared to the template.</p>
  64   </li>
  65 </ul>
  66 <ul>
  67   <li>
  68   <p><i>template_instance</i> is a (receiving) template which the value is compared to.</p>
  69   </li>
  70 </ul>
  71 <hr align="left" width="50%">
  72 <p><a name="Example 1">Example 1</a>
  73 <p><font face="Courier New">template integer tr_LessThan10 := (-infinity..9);<br>
  74 var integer vl_RxValue := 3;<br>
  75 var boolean vl_gyufa := match( vl_RxValue, tr_LessThan10))</font>
  76 <p>The value of vl_gyufa will be true because the value of the variable vl_RxValue (3) matches the template tr_LessThan10.</p>
  77 <hr align="left" width="25%">
  78 <hr align="left" width="25%">
  79 <p><a HREF="BNF.html#matchop">BNF definition</a> of <font face="Courier New">match</font></p>
  80 </body>
  81 </html>