File: string.md

package info (click to toggle)
openigtlink 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,080 kB
  • sloc: cpp: 20,076; ansic: 6,704; sh: 227; perl: 74; makefile: 46
file content (84 lines) | stat: -rwxr-xr-x 1,780 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
---
layout: page
title: Specification > Image
header: Pages
---
{% include JB/setup %}


## Summary

STRING message type is used for transferring a character string. It supports character strings up to 65535 bytes.

## Message Types

### STRING

<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"> ENCODING
</td><td align="left"> uint16
</td><td align="left"> Character encoding type as MIBenum value (defined by IANA). Default=3.
</td></tr>
<tr>
<td align="left"> LENGTH
</td><td align="left"> uint16
</td><td align="left"> Length of string (bytes)
</td></tr>
<tr>
<td align="left"> STRING
</td><td align="left"> uint8[LENGTH]
</td><td align="left"> Byte array of the string
</td></tr>
</tbody></table>

* For character encoding, please refer [IANA Character Sets](http://www.iana.org/assignments/character-sets). US-ASCII (ANSI-X3.4-1968; MIBenum = 3) is strongly recommended.

### GET_STRING

<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>

### STT_STRING

N/A

### STP_STRING

N/A


### RTS_STRING

N/A

## Implementations

The TDATA message type is implemented in the following source code.

* [igtlStringMessage.h](https://github.com/openigtlink/OpenIGTLink/blob/master/Source/igtlStringMessage.h)
* [igtlStringMessage.cxx](https://github.com/openigtlink/OpenIGTLink/blob/master/Source/igtlStringMessage.cxx)

## Contributors

* Junichi Tokuda