Difference between revisions of "OpenIGTLink/ProtocolV2/Type/Capability"

From NAMIC Wiki
Jump to: navigation, search
(Created page with ' << Version 2 Draft Page =Summary= The CAPABILITY data type lists the names of message types that the receiver can interpret. Althoug…')
 
Line 31: Line 31:
 
|}
 
|}
  
 
+
Number of type names '''N''' is calculated by (Body size) / 12.
'''Status codes:'''<br />
 
0 Invalid packet - 0 is not used<br />
 
1 OK (Default status)<br />
 
2 Unknown error<br />
 
3 Panic mode (emergency)<br />
 
4 Not found (file, configuration, device etc)<br />
 
5 Access denied<br />
 
6 Busy<br />
 
7 Time out / Connection lost<br />
 
8 Overflow / Can't be reached<br />
 
9 Checksum error<br />
 
10 Configuration error<br />
 
11 Not enough resource (memory, storage etc)<br />
 
12 Illegal/Unknown instruction (or feature not implemented / Unknown command received)<br />
 
13 Device not ready (starting up)<br />
 
14 Manual mode (device does not accept commands)<br />
 
15 Device disabled<br />
 
16 Device not present<br />
 
17 Device version not known<br />
 
18 Hardware failure<br />
 
19 Exiting / shut down in progress<br />
 
<br />
 
 
 
  
 
==GET_STATUS==
 
==GET_STATUS==

Revision as of 03:47, 30 June 2010

Home < OpenIGTLink < ProtocolV2 < Type < Capability

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

Data Type Description
TYPE_0 unsigned char [12] Type name #0
Type_1 unsigned char [12] Type name #1
... ... ...
Type_(N-1) unsigned char [12] Type name #N-1

Number of type names N is calculated by (Body size) / 12.

GET_STATUS

Data Type Description

STT_STATUS

N/A


STP_STATUS

N/A

Implementations

POSITION type is implemented in the following files:

Contributors

This message was originally proposed in version 1.

Comments