#include <gu_util.h>
#include <stdint.h>

Include dependency graph for wb_ball_position.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	wb_ball_position
	WHITEBOARD_POSTER_STRING_CONVERSION. More...

Macros
#define	_XOPEN_SOURCE 700

#define	BALL_POSITION_GENERATED

#define	BALL_POSITION_C_STRUCT wb_ball_position

#define	BALL_POSITION_NUMBER_OF_VARIABLES 6

#define	BALL_POSITION_DESC_BUFFER_SIZE 101

#define	BALL_POSITION_TO_STRING_BUFFER_SIZE 44

Functions
const char *	wb_ball_position_description (const struct wb_ball_position self, char descString, size_t bufferSize)
	Convert to a description string. More...

const char *	wb_ball_position_to_string (const struct wb_ball_position self, char toString, size_t bufferSize)
	Convert to a string. More...

struct wb_ball_position *	wb_ball_position_from_string (struct wb_ball_position self, const char str)
	Convert from a string. More...

double	wb_ball_position_confidence_percent (const struct wb_ball_position strct) __attribute__((const))
	WHITEBOARD_POSTER_STRING_CONVERSION. More...

void	wb_ball_position_set_confidence_percent (struct wb_ball_position *strct, const double newValue) __attribute__((nonnull))
	Converts and stores a percentage floating point value in wb_ball_position.confidence. More...

size_t	wb_ball_position_to_network_serialised (const struct wb_ball_position self, char dst)
	Network stream serialisation. More...

size_t	wb_ball_position_from_network_serialised (const char src, struct wb_ball_position dst)
	Network stream deserialisation. More...

Macro Definition Documentation

◆ _XOPEN_SOURCE

#define _XOPEN_SOURCE 700

Definition at line 72 of file wb_ball_position.h.

◆ BALL_POSITION_C_STRUCT

#define BALL_POSITION_C_STRUCT wb_ball_position

Definition at line 89 of file wb_ball_position.h.

◆ BALL_POSITION_DESC_BUFFER_SIZE

#define BALL_POSITION_DESC_BUFFER_SIZE 101

Definition at line 93 of file wb_ball_position.h.

◆ BALL_POSITION_GENERATED

#define BALL_POSITION_GENERATED

Definition at line 88 of file wb_ball_position.h.

◆ BALL_POSITION_NUMBER_OF_VARIABLES

#define BALL_POSITION_NUMBER_OF_VARIABLES 6

Definition at line 90 of file wb_ball_position.h.

◆ BALL_POSITION_TO_STRING_BUFFER_SIZE

#define BALL_POSITION_TO_STRING_BUFFER_SIZE 44

Definition at line 94 of file wb_ball_position.h.

Function Documentation

◆ wb_ball_position_confidence_percent()

double wb_ball_position_confidence_percent ( const struct wb_ball_position strct ) const

WHITEBOARD_POSTER_STRING_CONVERSION.

Converts wb_ball_position.confidence to its corresponding floating point percentage representation.

Parameters

[in] strct The wb_ball_position containing the confidence property being converted.

Returns: A double representing wb_ball_position.confidence as a percentage where 0 represents 0.0 and 255 represents 1.0.

◆ wb_ball_position_description()

const char * wb_ball_position_description	(	const struct wb_ball_position *	self,
		char *	descString,
		size_t	bufferSize
	)

Convert to a description string.

Definition at line 125 of file wb_ball_position.c.

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

◆ wb_ball_position_from_network_serialised()

size_t wb_ball_position_from_network_serialised	(	const char *	src,
		struct wb_ball_position *	dst
	)

Network stream deserialisation.

Definition at line 463 of file wb_ball_position.c.

References wb_ball_position::confidence, ntohs, wb_ball_position::pitchInDegrees, wb_ball_position::rollInDegrees, wb_ball_position::x, wb_ball_position::y, and wb_ball_position::yawInDegrees.

◆ wb_ball_position_from_string()

struct wb_ball_position * wb_ball_position_from_string	(	struct wb_ball_position *	self,
		const char *	str
	)

Convert from a string.

Definition at line 237 of file wb_ball_position.c.

References BALL_POSITION_DESC_BUFFER_SIZE.

◆ wb_ball_position_set_confidence_percent()

void wb_ball_position_set_confidence_percent	(	struct wb_ball_position *	strct,
		const double	newValue
	)

Converts and stores a percentage floating point value in wb_ball_position.confidence.

Parameters

[in,out]	strct	A pointer to awb_ball_position containing the confidence property which will be set.
[in]	newValue	The floating point percentage value which will be converted to the integer representations such that 0.0 equals 0 and 1.0 equals 255.

Definition at line 589 of file wb_ball_position.c.

References wb_ball_position::confidence.

◆ wb_ball_position_to_network_serialised()

size_t wb_ball_position_to_network_serialised	(	const struct wb_ball_position *	self,
		char *	dst
	)

Network stream serialisation.

Definition at line 368 of file wb_ball_position.c.

References htons.

◆ wb_ball_position_to_string()

const char * wb_ball_position_to_string	(	const struct wb_ball_position *	self,
		char *	toString,
		size_t	bufferSize
	)

Convert to a string.

Definition at line 181 of file wb_ball_position.c.

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

Classes

Macros

Functions