OpenIGTLink/ProtocolV2/Type/Status - Revision history

Tokuda at 04:41, 30 November 2011

2011-11-30T04:41:55Z

Tokuda: /* RTS_STATUS */

2010-11-30T05:16:53Z

RTS_STATUS

Tokuda: /* STP_STATUS */

2010-11-30T05:16:40Z

STP_STATUS

Tokuda at 02:54, 1 July 2010

2010-07-01T02:54:30Z

Tokuda: /* Implementations */

2010-06-30T03:44:06Z

Implementations

Tokuda: Created page with ' << Version 2 Draft Page =Summary= The STATUS data type is used to notify the receiver about the current status of the sender. The da…'

2010-06-30T03:43:38Z

Created page with ' << Version 2 Draft Page =Summary= The STATUS data type is used to notify the receiver about the current status of the sender. The da…'

New page

[[OpenIGTLink/ProtocolV2/Proposals | << Version 2 Draft Page]]

=Summary=
The STATUS data type is used to notify the receiver about the current status of the sender. The data consist of status code in a 16-bit unsigned integer, sub code in a 64-bit integer, error name in a 20-byte-length character string, and a status message. The length of the status message is determined by the size information in the general header. The status code is defined as a part of the OpenIGTLink protocol specification listed in Table 1. The sub code is device specific and is defined by developers. In addition, developers can build their own error name/code into the status message and additional optional description in the following data field.

=Message Types=
==STATUS==
{| border="1" cellpadding="5" cellspacing="0"
|-
| align="left style="background:#e0e0e0;" | Data
| align="left style="background:#e0e0e0;" | Type
| align="left style="background:#e0e0e0;" | Description
|-
| align="left" | C
| align="left" | Unsigned short (16bit)
| align="left" | Status code groups: 1-Ok, 2-Generic Error, ... (see below)
|-
| align="left" | Sub Code
| align="left" | 64 bit integer
| align="left" | Sub code for the error (ex. 0x200 - file not found)
|-
| align="left" | Error name
| align="left" | char[20]
| align="left" | "Error", "OK", "Warning" - can be anything, don't relay on this
|-
| align="left" | Status Message (optional)
| align="left" | char[ BodySize - 30 ]
| align="left" | Optional (English) description (ex. "File C:\test.ini not found")
|-
|}

'''Status codes:''' 
0 Invalid packet - 0 is not used 
1 OK (Default status) 
2 Unknown error 
3 Panic mode (emergency) 
4 Not found (file, configuration, device etc) 
5 Access denied 
6 Busy 
7 Time out / Connection lost 
8 Overflow / Can't be reached 
9 Checksum error 
10 Configuration error 
11 Not enough resource (memory, storage etc) 
12 Illegal/Unknown instruction (or feature not implemented / Unknown command received) 
13 Device not ready (starting up) 
14 Manual mode (device does not accept commands) 
15 Device disabled 
16 Device not present 
17 Device version not known 
18 Hardware failure 
19 Exiting / shut down in progress 
 

==GET_STATUS==
{| border="1" cellpadding="5" cellspacing="0" align="center"
|-
| align="left style="background:#e0e0e0;" | Data
| align="left style="background:#e0e0e0;" | Type
| align="left style="background:#e0e0e0;" | Description
|-
|}

==STT_STATUS==

N/A

==STP_STATUS==

N/A

=Implementations=
POSITION type is implemented in the following files:
*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlPositionMessage.h igtlPositionMessage.h]
*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlPositionMessage.cxx igtlPositionMessage.cxx]

=Contributors=
This message was originally proposed in version 1.

=Comments=

← Older revision		Revision as of 04:41, 30 November 2011
Line 1:		Line 1:
−	[[OpenIGTLink/ProtocolV2/~~Draft~~ \| << Version 2 ~~Draft~~ Page]]	+	[[OpenIGTLink/ProtocolV2/Index \| << Version 2 Index Page]]

	=Summary=		=Summary=

← Older revision		Revision as of 02:54, 1 July 2010
Line 1:		Line 1:
−	[[OpenIGTLink/ProtocolV2/~~Proposals~~ \| << Version 2 Draft Page]]	+	[[OpenIGTLink/ProtocolV2/Draft \| << Version 2 Draft Page]]

	=Summary=		=Summary=

@@ Line 75: / Line 75: @@
 ==RTS_STATUS==
-{| border="1" cellpadding="5" cellspacing="0" align="center"
+N/A
 =Implementations=

← Older revision		Revision as of 05:16, 30 November 2010
Line 72:		Line 72:

	N/A		N/A
		+
		+	==RTS_STATUS==
		+
		+	{\| border="1" cellpadding="5" cellspacing="0" align="center"
		+	\|-
		+	\| align="left style="background:#e0e0e0;" \| Data
		+	\| align="left style="background:#e0e0e0;" \| Type
		+	\| align="left style="background:#e0e0e0;" \| Description
		+	\|-
		+	\| align="left" \| Status
		+	\| align="left" \| 8 bit unsigned
		+	\| align="left" \| 0: Success 1: Error
		+	\|-
		+	\|}

	=Implementations=		=Implementations=

@@ Line 75: / Line 75: @@
 =Implementations=
 POSITION type is implemented in the following files:
-*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlPositionMessage.h igtlPositionMessage.h]
+*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlStatusMessage.h igtlStatusMessage.h]
-*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlPositionMessage.cxx igtlPositionMessage.cxx]
+*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlStatusMessage.cxx igtlStatusMessage.cxx]
 =Contributors=