Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
Classes | Macros
igtl_qtdata.h File Reference
#include "igtl_win32header.h"
#include "igtl_util.h"
#include "igtl_types.h"
Include dependency graph for igtl_qtdata.h:

Go to the source code of this file.

Classes

struct  igtl_qtdata_element
 
struct  igtl_rts_qtdata
 
struct  igtl_stt_qtdata
 

Macros

#define IGTL_QTDATA_ELEMENT_SIZE   50
 
#define IGTL_QTDATA_LEN_NAME   20 /* Maximum length of tracking instrument name */
 
#define IGTL_QTDATA_TYPE_3D   3 /* 3D instrument (only tip of the instrument defined) */
 
#define IGTL_QTDATA_TYPE_5D
 
#define IGTL_QTDATA_TYPE_6D   2 /* 6D instrument (regular instrument) */
 
#define IGTL_QTDATA_TYPE_TRACKER   1 /* Tracker */
 
#define IGTL_RTS_QTDATA_SIZE   1
 
#define IGTL_STT_QTDATA_LEN_COORDNAME   32 /* Maximum length of coordinate system name */
 
#define IGTL_STT_QTDATA_SIZE   36
 
void igtl_export igtl_qtdata_convert_byte_order (igtl_qtdata_element *qtdatalist, int nelem)
 
igtl_uint64 igtl_export igtl_qtdata_get_crc (igtl_qtdata_element *qtdatalist, int nelem)
 
#define igtl_qtdata_get_data_n(size)   ((size) / IGTL_QTDATA_ELEMENT_SIZE)
 
#define igtl_qtdata_get_data_size(n)   ((n) * IGTL_QTDATA_ELEMENT_SIZE)
 
void igtl_export igtl_rts_qtdata_convert_byte_order (igtl_rts_qtdata *rts_qtdata)
 
igtl_uint64 igtl_export igtl_rts_qtdata_get_crc (igtl_rts_qtdata *rts_qtdata)
 
void igtl_export igtl_stt_qtdata_convert_byte_order (igtl_stt_qtdata *stt_qtdata)
 
igtl_uint64 igtl_export igtl_stt_qtdata_get_crc (igtl_stt_qtdata *stt_qtdata)
 

Macro Definition Documentation

◆ IGTL_QTDATA_ELEMENT_SIZE

#define IGTL_QTDATA_ELEMENT_SIZE   50

Definition at line 22 of file igtl_qtdata.h.

◆ igtl_qtdata_get_data_n

#define igtl_qtdata_get_data_n (   size)    ((size) / IGTL_QTDATA_ELEMENT_SIZE)

igtl_qtdata_get_data_n(size) calculates the number of qtdatas in the body, based on the body size. This function may be used when a client program parses a QTDATA message.

Definition at line 70 of file igtl_qtdata.h.

◆ igtl_qtdata_get_data_size

#define igtl_qtdata_get_data_size (   n)    ((n) * IGTL_QTDATA_ELEMENT_SIZE)

igtl_qtdata_get_data_size(n) calculates the size of body based on the number of qtdatas. The size of body is used in the message header.

Definition at line 66 of file igtl_qtdata.h.

◆ IGTL_QTDATA_LEN_NAME

#define IGTL_QTDATA_LEN_NAME   20 /* Maximum length of tracking instrument name */

Definition at line 26 of file igtl_qtdata.h.

◆ IGTL_QTDATA_TYPE_3D

#define IGTL_QTDATA_TYPE_3D   3 /* 3D instrument (only tip of the instrument defined) */

Definition at line 31 of file igtl_qtdata.h.

◆ IGTL_QTDATA_TYPE_5D

#define IGTL_QTDATA_TYPE_5D
Value:
4 /* 5D instrument (tip and handle are defined,
but not the normal vector) */

Definition at line 32 of file igtl_qtdata.h.

◆ IGTL_QTDATA_TYPE_6D

#define IGTL_QTDATA_TYPE_6D   2 /* 6D instrument (regular instrument) */

Definition at line 30 of file igtl_qtdata.h.

◆ IGTL_QTDATA_TYPE_TRACKER

#define IGTL_QTDATA_TYPE_TRACKER   1 /* Tracker */

Definition at line 29 of file igtl_qtdata.h.

◆ IGTL_RTS_QTDATA_SIZE

#define IGTL_RTS_QTDATA_SIZE   1

Definition at line 24 of file igtl_qtdata.h.

◆ IGTL_STT_QTDATA_LEN_COORDNAME

#define IGTL_STT_QTDATA_LEN_COORDNAME   32 /* Maximum length of coordinate system name */

Definition at line 27 of file igtl_qtdata.h.

◆ IGTL_STT_QTDATA_SIZE

#define IGTL_STT_QTDATA_SIZE   36

Definition at line 23 of file igtl_qtdata.h.

Function Documentation

◆ igtl_qtdata_convert_byte_order()

void igtl_export igtl_qtdata_convert_byte_order ( igtl_qtdata_element qtdatalist,
int  nelem 
)

Byte order conversion for an array of QTDATA, STT_QTDATA and RTS_QTDATA data structure Converts endianness of each element in an array of igtl_qtdata_element from host byte order to network byte order, or vice versa.

◆ igtl_qtdata_get_crc()

igtl_uint64 igtl_export igtl_qtdata_get_crc ( igtl_qtdata_element qtdatalist,
int  nelem 
)

Calculates CRC of QTDATA, STT_QTDATA and RTS_QTDATA messages

◆ igtl_rts_qtdata_convert_byte_order()

void igtl_export igtl_rts_qtdata_convert_byte_order ( igtl_rts_qtdata rts_qtdata)

igtl_qtdata_get_data_size(n) calculates the size of body based on the number of qtdatas. The size of body is used in the message header.

◆ igtl_rts_qtdata_get_crc()

igtl_uint64 igtl_export igtl_rts_qtdata_get_crc ( igtl_rts_qtdata rts_qtdata)

igtl_qtdata_get_data_size(n) calculates the size of body based on the number of qtdatas. The size of body is used in the message header.

◆ igtl_stt_qtdata_convert_byte_order()

void igtl_export igtl_stt_qtdata_convert_byte_order ( igtl_stt_qtdata stt_qtdata)

igtl_qtdata_get_data_size(n) calculates the size of body based on the number of qtdatas. The size of body is used in the message header.

◆ igtl_stt_qtdata_get_crc()

igtl_uint64 igtl_export igtl_stt_qtdata_get_crc ( igtl_stt_qtdata stt_qtdata)

igtl_qtdata_get_data_size(n) calculates the size of body based on the number of qtdatas. The size of body is used in the message header.


Generated for OpenIGTLink by Doxygen 1.9.8 written by Dimitri van Heesch, © 1997-2012