gusimplewhiteboard
wb_my_position.h File Reference
#include <gu_util.h>
#include <stdint.h>
Include dependency graph for wb_my_position.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  wb_my_position
 WHITEBOARD_POSTER_STRING_CONVERSION. More...
 

Macros

#define _XOPEN_SOURCE   700
 
#define MY_POSITION_GENERATED
 
#define MY_POSITION_C_STRUCT   wb_my_position
 
#define MY_POSITION_NUMBER_OF_VARIABLES   3
 
#define MY_POSITION_DESC_BUFFER_SIZE   35
 
#define MY_POSITION_TO_STRING_BUFFER_SIZE   23
 

Functions

const char * wb_my_position_description (const struct wb_my_position *self, char *descString, size_t bufferSize)
 Convert to a description string. More...
 
const char * wb_my_position_to_string (const struct wb_my_position *self, char *toString, size_t bufferSize)
 Convert to a string. More...
 
struct wb_my_positionwb_my_position_from_string (struct wb_my_position *self, const char *str)
 Convert from a string. More...
 
size_t wb_my_position_to_network_serialised (const struct wb_my_position *self, char *dst)
 WHITEBOARD_POSTER_STRING_CONVERSION. More...
 
size_t wb_my_position_from_network_serialised (const char *src, struct wb_my_position *dst)
 Network stream deserialisation. More...
 

Macro Definition Documentation

◆ _XOPEN_SOURCE

#define _XOPEN_SOURCE   700

Definition at line 72 of file wb_my_position.h.

◆ MY_POSITION_C_STRUCT

#define MY_POSITION_C_STRUCT   wb_my_position

Definition at line 89 of file wb_my_position.h.

◆ MY_POSITION_DESC_BUFFER_SIZE

#define MY_POSITION_DESC_BUFFER_SIZE   35

Definition at line 93 of file wb_my_position.h.

◆ MY_POSITION_GENERATED

#define MY_POSITION_GENERATED

Definition at line 88 of file wb_my_position.h.

◆ MY_POSITION_NUMBER_OF_VARIABLES

#define MY_POSITION_NUMBER_OF_VARIABLES   3

Definition at line 90 of file wb_my_position.h.

◆ MY_POSITION_TO_STRING_BUFFER_SIZE

#define MY_POSITION_TO_STRING_BUFFER_SIZE   23

Definition at line 94 of file wb_my_position.h.

Function Documentation

◆ wb_my_position_description()

const char * wb_my_position_description ( const struct wb_my_position self,
char *  descString,
size_t  bufferSize 
)

Convert to a description string.

Definition at line 125 of file wb_my_position.c.

Referenced by guWhiteboard::MyPosition::description().

◆ wb_my_position_from_network_serialised()

size_t wb_my_position_from_network_serialised ( const char *  src,
struct wb_my_position dst 
)

Network stream deserialisation.

Network stream deserialisation.

Definition at line 352 of file wb_my_position.c.

References wb_my_position::heading, ntohs, wb_my_position::x, and wb_my_position::y.

◆ wb_my_position_from_string()

struct wb_my_position * wb_my_position_from_string ( struct wb_my_position self,
const char *  str 
)

Convert from a string.

Definition at line 189 of file wb_my_position.c.

References MY_POSITION_DESC_BUFFER_SIZE.

◆ wb_my_position_to_network_serialised()

size_t wb_my_position_to_network_serialised ( const struct wb_my_position self,
char *  dst 
)

WHITEBOARD_POSTER_STRING_CONVERSION.

Network stream serialisation

WHITEBOARD_POSTER_STRING_CONVERSION.

Definition at line 299 of file wb_my_position.c.

References htons.

◆ wb_my_position_to_string()

const char * wb_my_position_to_string ( const struct wb_my_position self,
char *  toString,
size_t  bufferSize 
)

Convert to a string.

Definition at line 157 of file wb_my_position.c.

Referenced by guWhiteboard::MyPosition::to_string().