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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
---
layout: page
title: Specification > Bind
header: Pages
---
{% include JB/setup %}
## Summary
Bind message format is designed to bind any OpenIGTLink messages into a single message. Messages bound in a BIND message are called 'child messages.' The BIND message format is useful, when one needs to care about synchronization of multiple messages (e.g. multi-channel sensors), or sending associative array (pairs of key string and value). The bind message format consists of the bind header section, which contains types and sizes of child messages, the child message name table section, and the child message body section.
## Message Types
### BIND
<table border="1" cellpadding="5" cellspacing="0" align="center">
<tbody><tr>
<td align="left" style="background:#e0e0e0;"> Data
</td><td align="left" style="background:#e0e0e0;"> Type
</td><td align="left" style="background:#e0e0e0;"> Description
</td></tr>
<tr>
<td align="left"> NCMESSAGES
</td><td align="left"> uint16
</td><td align="left"> Number of child messages
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">Bind Header Section
</td></tr>
<tr>
<td align="left"> TYPE 0
</td><td align="left"> char[12]
</td><td align="left"> Data type (OpenIGTLink Device Type string) for child message 0
</td></tr>
<tr>
<td align="left"> DATA SIZE 0
</td><td align="left"> uint 64
</td><td align="left"> Data size for child message 0
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> TYPE (NCMESSAGES-1)
</td><td align="left"> char[12]
</td><td align="left"> Data type (OpenIGTLink Device Type string) for child message (NCMESSAGES-1)
</td></tr>
<tr>
<td align="left"> DATA SIZE (NCMESSAGES-1)
</td><td align="left"> uint 64
</td><td align="left"> Data size for child message (NCMESSAGES-1)
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">NAME Table Section (NULL-separated values)
</td></tr>
<tr>
<td align="left"> NAME_TABLE_SIZE
</td><td align="left"> uint16
</td><td align="left"> Size of name table (including the padding)
</td></tr>
<tr>
<td align="left"> NAME 0
</td><td align="left"> char[*]
</td><td align="left"> Name for child message 0
</td></tr>
<tr>
<td align="left"> (null)
</td><td align="left"> uint8
</td><td align="left"> separator
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> NAME (NCMESSAGES-1)
</td><td align="left"> char[*]
</td><td align="left"> Name for child message (NCMESSAGES-1)
</td></tr>
<tr>
<td align="left"> (null)
</td><td align="left"> uint8
</td><td align="left"> separator
</td></tr>
<tr>
<td align="left"> Padding*
</td><td align="left"> uint8 or none
</td><td align="left"> padding to align DATA with WORD
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">Data Section
</td></tr>
<tr>
<td align="left"> DATA 0
</td><td align="left"> TYPE 0 ( SIZE 0 )
</td><td align="left"> Data array for child message 0
</td></tr>
<tr>
<td align="left"> (Padding*)
</td><td align="left"> uint8 or none
</td><td align="left"> padding to align DATA with WORD
</td></tr>
<tr>
<td align="left"> DATA 1
</td><td align="left"> TYPE 1 ( SIZE 1 )
</td><td align="left"> Data array for child message 1
</td></tr>
<tr>
<td align="left"> (Padding*)
</td><td align="left"> uint8 or none
</td><td align="left"> padding to align DATA with WORD
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> DATA (NCMESSAGES-1)
</td><td align="left"> TYPE NCMESSAGE-1 (SIZE NCMESSAGE-1)
</td><td align="left"> Data array for child message NCMESSAGE-1
</td></tr>
<tr>
<td align="left"> Padding*
</td><td align="left"> uint8 or none
</td><td align="left"> padding to align DATA with WORD
</td></tr>
</tbody></table>
* Padding field is inserted only if the previous field does not aligned with WORD border.
### GET_BIND
GET_BIND is used to request the receiver for associative array data. If a GET_BIND message does not have a body, it requests all data.
<table border="1" cellpadding="5" cellspacing="0" align="center">
<tbody><tr>
<td style="background:#e0e0e0;"> Data
</td><td style="background:#e0e0e0;"> Type
</td><td style="background:#e0e0e0;"> Description
</td></tr>
<tr>
<td align="left"> NCMESSAGES
</td><td align="left"> uint16
</td><td align="left"> Number of elements
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">Bind Header Section
</td></tr>
<tr>
<td align="left"> TYPE 0
</td><td align="left"> char[12]
</td><td align="left"> Data type (OpenIGTLink device type string)
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> TYPE (NCMESSAGES-1)
</td><td align="left"> char[12]
</td><td align="left"> Data type (OpenIGTLink device type string)
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">NAME Table
</td></tr>
<tr>
<td align="left"> NAME_TABLE_SIZE
</td><td align="left"> uint16
</td><td align="left"> Size of name table (including the padding)
</td></tr>
<tr>
<td align="left"> NAME 0
</td><td align="left"> char[NAMELEN]
</td><td align="left"> Name
</td></tr>
<tr>
<td align="left"> NULL
</td><td align="left"> uint 8
</td><td align="left"> Separator
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> NAME (NCMESSAGES-1)
</td><td align="left"> char[NAMELEN (NCMESSAGES-1)]
</td><td align="left"> Name
</td></tr>
<tr>
<td align="left"> NULL
</td><td align="left"> uint 8
</td><td align="left"> Separator
</td></tr>
</tbody></table>
### STT_BIND
GET_BIND is used to request the receiver for associative array data. If a GET_BIND message does not have a body, it requests all data.
<table border="1" cellpadding="5" cellspacing="0" align="center">
<tbody><tr>
<td align="left" style="background:#e0e0e0;"> Data
</td><td align="left" style="background:#e0e0e0;"> Type
</td><td align="left" style="background:#e0e0e0;"> Description
</td></tr>
<tr>
<td align="left"> RESOL
</td><td align="left"> uint64
</td><td align="left"> Minimum interval between message (ns). Same format as <a href="/Wiki/index.php/OpenIGTLink/Timestamp" title="OpenIGTLink/Timestamp">TimeStamp</a>
</td></tr>
</tbody></table>
or
<table border="1" cellpadding="5" cellspacing="0" align="center">
<tbody><tr>
<td style="background:#e0e0e0;"> Data
</td><td style="background:#e0e0e0;"> Type
</td><td style="background:#e0e0e0;"> Description
</td></tr>
<tr>
<td align="left"> RESOL
</td><td align="left"> uint64
</td><td align="left"> Minimum interval between message (ns). Same format as <a href="/Wiki/index.php/OpenIGTLink/Timestamp" title="OpenIGTLink/Timestamp">TimeStamp</a>
</td></tr>
<tr>
<td align="left"> NCMESSAGES
</td><td align="left"> uint16
</td><td align="left"> Number of elements
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">Bind Header Section
</td></tr>
<tr>
<td align="left"> TYPE 0
</td><td align="left"> char[12]
</td><td align="left"> Data type (OpenIGTLink device type string)
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> TYPE (NCMESSAGES-1)
</td><td align="left"> char[12]
</td><td align="left"> Data type (0: string, 1: scalar, 2: vector)
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#e0e0e0;">NAME Table Section (NULL-separated values)
</td></tr>
<tr>
<td align="left"> NAME_TABLE_SIZE
</td><td align="left"> uint16
</td><td align="left"> Size of name table (including the padding)
</td></tr>
<tr>
<td align="left"> NAME 0
</td><td align="left"> char[*]
</td><td align="left"> Name
</td></tr>
<tr>
<td align="left"> (null)
</td><td align="left"> uint8
</td><td align="left"> separator
</td></tr>
<tr>
<td colspan="3" align="left" style="background:#f0f0f0;">...
</td></tr>
<tr>
<td align="left"> NAME (NCMESSAGES-1)
</td><td align="left"> char[*]
</td><td align="left"> Name
</td></tr>
<tr>
<td align="left"> (null)
</td><td align="left"> uint8
</td><td align="left"> separator
</td></tr>
</tbody></table>
### STP_BIND
<table border="1" cellpadding="5" cellspacing="0" align="center">
<tbody><tr>
<td style="background:#e0e0e0;"> Data
</td><td style="background:#e0e0e0;"> Type
</td><td style="background:#e0e0e0;"> Description
</td></tr>
</tbody></table>
### RTS_BIND
<table border="1" cellpadding="5" cellspacing="0" align="center">
<tbody><tr>
<td style="background:#e0e0e0;"> Data
</td><td style="background:#e0e0e0;"> Type
</td><td style="background:#e0e0e0;"> Description
</td></tr>
<tr>
<td align="left"> Status
</td><td align="left"> 8 bit unsigned
</td><td align="left"> 0: Success 1: Error
</td></tr>
</tbody></table>
## Implementations
* [igtlBindMessage.h](https://github.com/openigtlink/OpenIGTLink/blob/master/Source/igtlBindMessage.h)
* [igtlBindMessage.cxx](https://github.com/openigtlink/OpenIGTLink/blob/master/Source/igtlBindMessage.cxx)
## Contributors
* Junichi Tokuda
|
