File: v-sim-extraNode.html

package info (click to toggle)
v-sim 3.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 15,860 kB
  • sloc: ansic: 75,222; sh: 10,239; makefile: 580; python: 572; cpp: 353; xml: 130
file content (139 lines) | stat: -rw-r--r-- 7,760 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>extraNode</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch06.html" title="Extra functionalities">
<link rel="prev" href="v-sim-dataNode.html" title="dataNode">
<link rel="next" href="v-sim-plane.html" title="plane">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="v-sim-dataNode.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-plane.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-extraNode.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-extraNode.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="extraNode">
<a name="v-sim-extraNode"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-extraNode.top_of_page"></a>extraNode</span></h2>
<p>extraNode — add further characteristics to the nodes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-extraNode.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span>                <a class="link" href="v-sim-extraNode.html#extraNodeAdd-label" title="extraNodeAdd_label ()">extraNodeAdd_label</a>                  (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-extraNode.html#extraNodeSet-label" title="extraNodeSet_label ()">extraNodeSet_label</a>                  (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
                                                         <em class="parameter"><code>unsigned <span class="type">int</span> nodeId</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*        <a class="link" href="v-sim-extraNode.html#extraNodeGet-label" title="extraNodeGet_label ()">extraNodeGet_label</a>                  (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> *node</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-extraNode.description"></a><h2>Description</h2>
<p>
</p>
<p>blabla</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-extraNode.details"></a><h2>Details</h2>
<div class="refsect2" title="extraNodeAdd_label ()">
<a name="extraNodeAdd-label"></a><h3>extraNodeAdd_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                extraNodeAdd_label                  (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
Add the possibility to store labels for nodes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="extraNodeSet_label ()">
<a name="extraNodeSet-label"></a><h3>extraNodeSet_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                extraNodeSet_label                  (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
                                                         <em class="parameter"><code>unsigned <span class="type">int</span> nodeId</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre>
<p>
Set a <em class="parameter"><code>label</code></em> to the node <em class="parameter"><code>nodeId</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodeId</code></em> :</span></p></td>
<td>the id of a node.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>the label to set (will be copied).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="extraNodeGet_label ()">
<a name="extraNodeGet-label"></a><h3>extraNodeGet_label ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*        extraNodeGet_label                  (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> *node</code></em>);</pre>
<p>
Retrieve the label of <em class="parameter"><code>node</code></em>. If <em class="parameter"><code>node</code></em> has no label, NULL is
returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
<td>a given node
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a label, private value, do not freed.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>