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 (72 lines) | stat: -rw-r--r-- 1,403 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
[Back to Index](/Documents/Protocol/index.md)

String Message
==============

- Protocol Version: 3.0
- Release Date: January 20, 2017


Summary
=======

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

Message Types
=============

STRING
------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
 ENCODING     | uint16        | Character encoding type as MIBenum value. Default=3.
 LENGTH       | uint16        | Length of string (bytes)
 STRING       | uint8[LENGTH] | Byte array of the string

* For MIBenum 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
-------------------

 Data         | Type          | Description
--------------|---------------|-------------------------------------------------
              |               |

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](/Source/igtlStringMessage.h)
* [igtlStringMessage.cxx](/Source/igtlStringMessage.cxx)

Contributors
===================

* Junichi Tokuda