help/info/raise.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>raise</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="public.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="read.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>raise</h1>
  33 <hr align="left" width="75%">
  34 <p>The operation belongs to the family of procedure-based communication operations. It is used to raise an exception as a reaction to an accepted procedure call the result of which leads to an
  35 exceptional event.
  36 <ul>
  37   <li>The operation can be used on connected procedure-based (or mixed) ports.</li>
  38   <li>In case of multiple connections the receiver may be addressed.</li>
  39 </ul>
  40 <p>Related keywords:</p>
  41 <ul>
  42   <li><a href="address.html"><b><font face="Courier New" color="#003258" size="4">address</font></b></a></li>
  43   <li><a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a></li>
  44   <li><a href="signature.html"><b><font face="Courier New" color="#003258" size="4">signature</font></b></a></li>
  45   <li><a href="system.html"><b><font face="Courier New" color="#003258" size="4">system</font></b></a></li>
  46   <li><a href="to.html"><b><font face="Courier New" color="#003258" size="4">to</font></b></a></li>
  47 </ul>
  48 <hr align="left" width="50%">
  49 <div align="center">
  50 <center>
  51 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  52   <tr>
  53     <td width="100%">
  54     <h3 align="center"><i>port_reference</i><font face="Courier New" color="#003258" size="5"><b>.raise (</b></font><i> signature_reference </i><font face="Courier New" color="#003258" size="5"><b>,</b></font>
  55     [ <i>exception_type</i><font face="Courier New" color="#003258" size="5"><b>:</b></font>]<i>exception_value </i><font face="Courier New" color="#003258" size="5"><b>)</b></font> [ <font
  56       face="Courier New" color="#003258" size="5"><b>to</b></font><i> address_reference</i> ] <font face="Courier New" color="#003258" size="5"><b>;</b></font> &nbsp;</h3>
  57     </td>
  58   </tr>
  59 </table>
  60 </center>
  61 </div>
  62 <ul>
  63   <li>
  64   <p><i> port_reference</i> points out the port where the exception is sent through.</p>
  65   </li>
  66   <li>
  67   <p>The <b><font face="Courier New" color="#003258" size="4">raise</font> </b>keyword introduces the exception.</p>
  68   </li>
  69   <li>
  70   <p><i>signature_reference</i> points out the signature where the exception is defined</p>
  71   </li>
  72   <li>
  73   <p>The optional <i>exception_type</i> is used to point out the type of the value representing the exception when several types have been defined in the signature.</p>
  74   </li>
  75   <li>
  76   <p><i>exception_value</i> is the value representing the exception&nbsp;</p>
  77   </li>
  78   <li>
  79   <p>The optional <b><font face="Courier New" color="#003258" size="4">to</font> </b> keyword is used when a port is connected to several entities and identification of the communication partner
  80   is required.</p>
  81   </li>
  82 </ul>
  83 <ul>
  84   <li>
  85   <p><i>address_reference</i> is one of the following:</p>
  86   <ul>
  87     <li>a component reference (cf. <a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a>)&nbsp; or the keyword <a href="system.html"
  88       target="_blank"><b><font face="Courier New" color="#003258" size="4">system</font></b></a>, in case of one-to-many connections.</li>
  89     <li>an address reference (cf. <a href="address.html"><b><font face="Courier New" color="#003258" size="4">address</font></b></a>) , when there are several entities within the
  90     system under test.</li>
  91   </ul>
  92   </li>
  93 </ul>
  94 <hr align="left" width="50%">
  95 <p><a name="Example 1">Example 1</a>:
  96 <p><font face="Courier New">signature S_MyProccc (in charset pl_MyPar71) exception (integer, float);<br>
  97 <br>
  98 MujPort_PCO.raise(S_MyProccc, integer:19) to system;</font>
  99 <p>The signature S_MyProccc suitable for blocking communication is defined in the first line. It has one parameter (pl_MyPar71) and it may raise exceptions of integer and floating point type. In
 100 the second line, the exception is raised at&nbsp; the port MujPort_PCO. The port is connected to several components therefore it must be addressed, in our case to the test system interface. The
 101 exception raised is represented by an integer value (19)&nbsp;</p>
 102 <hr align="left" width="25%">
 103 <hr align="left" width="25%">
 104 <p><a HREF="BNF.html#raisestatement">BNF definition</a> of <font face="Courier New"> raise</font></p>
 105 </body>
 106 </html>