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

Go to the source code of this file.

Classes

struct  igtl_bind_child_info
 
struct  igtl_bind_info
 

Functions

int igtl_export igtl_bind_alloc_info (igtl_bind_info *bind_info, igtl_uint16 ncmessages)
 
int igtl_export igtl_bind_free_info (igtl_bind_info *bind_info)
 
igtl_uint64 igtl_export igtl_bind_get_crc (igtl_bind_info *info, int type, void *bind_message)
 
igtl_uint64 igtl_export igtl_bind_get_size (igtl_bind_info *info, int type)
 
void igtl_export igtl_bind_init_info (igtl_bind_info *bind_info)
 
int igtl_export igtl_bind_pack (igtl_bind_info *info, void *byte_array, int type)
 
int igtl_export igtl_bind_unpack (int type, void *byte_array, igtl_bind_info *info, igtl_uint64 size)
 

Function Documentation

int igtl_export igtl_bind_alloc_info ( igtl_bind_info bind_info,
igtl_uint16  ncmessages 
)

Allocates an array of igtl_bind_child_info in bind_info with length of 'ncmessages.' Returns 1 if the array is successfully allocated/freed

int igtl_export igtl_bind_free_info ( igtl_bind_info bind_info)

Frees an array of igtl_bind_child_info in bind_info with length of 'ncmessages.' Returns 1 if the array is successfully allocated/freed

igtl_uint64 igtl_export igtl_bind_get_crc ( igtl_bind_info info,
int  type,
void *  bind_message 
)

Calculates CRC of BIND message. Note that 'info' is used only for getting size of the message.

igtl_uint64 igtl_export igtl_bind_get_size ( igtl_bind_info info,
int  type 
)

igtl_bind_get_size() calculates the size of bind header, consisting of BIND hearder section (including number of child messages) and name table section based on a igtl_bind_header. The size returned from this function does not include size of child message data. 'type' argument specifies a message type prefix (none, GET_, STT_, STP_ or RTS_) by IGTL_TYPE_PREFIX_* macro.

void igtl_export igtl_bind_init_info ( igtl_bind_info bind_info)

Initializes igtl_bind_info

int igtl_export igtl_bind_pack ( igtl_bind_info info,
void *  byte_array,
int  type 
)

Packs BIND message. Converts an igtl_bind_info structure to a byte array. 'byte_array' should be allocated prior to calling igtl_bind_pack() with memory size calculated by igtl_bind_get_size(). 'type' argument specifies a message type prefix (none, GET_, STT_, STP_ or RTS_) by IGTL_TYPE_PREFIX_* macro. Returns 1 if success, otherwise 0.

int igtl_export igtl_bind_unpack ( int  type,
void *  byte_array,
igtl_bind_info info,
igtl_uint64  size 
)

Unpacks BIND message. Extracts information about child messages in a byte array of BIND messages and store it in a igtl_bind_info structure. 'type' argument specifies a message type prefix (none, GET_, STT_, STP_ or RTS_) by IGTL_TYPE_PREFIX_* macro. Returns 1 if success, otherwise 0.


Generated at Mon Nov 11 2013 05:19:49 for OpenIGTLink by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2012