OpenIGTLink/ProtocolV2/Type/Capability - Revision history

Tokuda at 04:42, 30 November 2011

2011-11-30T04:42:10Z

Tokuda: /* Implementations */

2010-11-30T05:17:39Z

Implementations

Tokuda: /* STP_CAPABIL */

2010-11-30T05:17:27Z

STP_CAPABIL

Tokuda at 02:54, 1 July 2010

2010-07-01T02:54:45Z

Tokuda: /* Message Types */

2010-06-30T03:48:11Z

Message Types

Tokuda: /* Message Types */

2010-06-30T03:47:31Z

Message Types

Tokuda: Created page with ' << Version 2 Draft Page =Summary= The CAPABILITY data type lists the names of message types that the receiver can interpret. Althoug…'

2010-06-30T03:46:33Z

Created page with ' << Version 2 Draft Page =Summary= The CAPABILITY data type lists the names of message types that the receiver can interpret. Althoug…'

New page

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

=Summary=
The CAPABILITY data type lists the names of message types that the receiver can interpret. Although the OpenIGTLink protocol guarantees that any receiver can at least skip messages with unknown type and continue to interpret the following messages, it is a good idea to get the capability information at system startup to ensure application-level compatibility of various devices. In a CAPABILITY message type, each message type name comes with format version number. If the receiver can interpret multiple versions for a certain message type, they should be listed as independent types.

=Message Types=
==CAPABILITY==
{| 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" | TYPE_0
| align="left" | unsigned char [12]
| align="left" | Type name #0
|-
| align="left" | Type_1
| align="left" | unsigned char [12]
| align="left" | Type name #1
|-
| align="left" | ...
| align="left" | ...
| align="left" | ...
|-
| align="left" | Type_(N-1)
| align="left" | unsigned char [12]
| align="left" | Type name #N-1
|-
|}

'''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/igtlStatusMessage.h igtlStatusMessage.h]
*[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlStatusMessage.cxx igtlStatusMessage.cxx]

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

=Comments=

← Older revision		Revision as of 04:42, 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 05:17, 30 November 2010
Line 56:		Line 56:

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

	=Contributors=		=Contributors=

← Older revision		Revision as of 05:17, 30 November 2010
Line 48:		Line 48:

	==STP_CAPABIL==		==STP_CAPABIL==
		+
		+	N/A
		+
		+	==RTS_CAPABIL==

	N/A		N/A

← 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 33: / Line 33: @@
 Number of type names '''N''' is calculated by (Body size) / 12.
-==GET_STATUS==
+==GET_CAPABIL==
 {| border="1" cellpadding="5" cellspacing="0" align="center"
 |-
@@ Line 42: / Line 42: @@
 |}
-==STT_STATUS==
+==STT_CAPABIL==
 N/A
-==STP_STATUS==
+==STP_CAPABIL==
 N/A