Sync with 5.4.0
[deliverable/titan.core.git] / help / info / valueof.html
CommitLineData
970ed795 1<!--
3abe9331 2 Copyright (c) 2000-2015 Ericsson Telecom AB
970ed795
EL
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>valueof</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="value.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
26 <td><a href="var.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>valueof</h1>
33<hr align="left" width="75%">
34<p>The operation belongs to the family of predefined functions operating on templates. It allows to convert a sending <b><font face="Courier New">template</font></b> into a value. The returned
35value can be saved into a variable of the same type as the type of the template.&nbsp;
36<ul>
37 <li>Permitted for specific value (sending) templates only, i.e., each field of the template shall resolve to a single value.</li>
38</ul>
39<hr align="left" width="50%">
40<p>Related keyword:</p>
41<ul>
42 <li><a href="template.html"><b><font face="Courier New" color="#003258" size="4">template</font></b></a></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>valueof (</b></font><i>&nbsp;template_instance</i><font face="Courier New" color="#003258" size="5"><b>)</b></font></h3>
51 </td>
52 </tr>
53</table>
54</center>
55</div>
56<ul>
57 <li>
58 <p>The&nbsp; <font face="Courier New" color="#003258" size="4"><b>valueof</b></font> keyword introduces the operation.</p>
59 </li>
60</ul>
61<ul>
62 <li>
63 <p><i>template_instance</i> is a (sending) template which should be converted to a value.</p>
64 </li>
65</ul>
66<hr align="left" width="50%">
67<p><a name="Example 1">Example 1</a>
68<p><font face="Courier New">type record TandemType {&nbsp;<br>
69&nbsp;&nbsp;&nbsp;integer field1,<br>
70&nbsp;&nbsp;&nbsp;boolean field2&nbsp;<br>
71};<br>
72template TandemType t_SetupTemplate := {&nbsp;<br>
73&nbsp;&nbsp;&nbsp;field1 := 1,&nbsp;<br>
74&nbsp;&nbsp;&nbsp;field2 := true&nbsp;<br>
75};<br>
76<br>
77var TandemType v_RecipeValue := valueof( t_SetupTemplate);</font>
78<p>The field1 of v_RecipeValue will have the value 1, whereas field2 will equal to true.</p>
79<hr align="left" width="25%">
80<hr align="left" width="25%">
81<p><a HREF="BNF.html#valueofop">BNF definition</a> of <font face="Courier New">valueof</font></p>
82</body>
83</html>
This page took 0.031117 seconds and 5 git commands to generate.