BroadcastMinMax.h File Reference

Min-Max spanning tree between robots. More...

Go to the source code of this file.

Data Structures
struct	BroadcastMinMaxMessage
	Broadcast Min-Max Message. More...

Typedefs
typedef struct BroadcastMinMaxMessage	BroadcastMinMaxMessage
	Broadcast Min-Max Message. More...

Functions
void	broadcastMinMaxCreate (BroadcastMinMaxMessage *msgPtr, char *name, uint8 val)
	creates a min/max broadcast message in msgPtr More...
void	broadcastMinMaxSet (BroadcastMinMaxMessage *msgPtr, uint8 val)
	creates a min/max broadcast message in msgPtr More...
void	broadcastMinMaxSetMaxPlusOne (BroadcastMinMaxMessage *msgPtr, NbrList *nbrListPtr)
	creates a min/max broadcast message in msgPtr More...
uint8	broadcastMinMaxUpdate (BroadcastMinMaxMessage *msgPtr, NbrList *nbrListPtr)
	propagates a min.max message More...
uint8	broadcastMinMaxGetValLocal (BroadcastMinMaxMessage *msgPtr)
	gets a min/max broadcast message local value in msgPtr More...
uint8	broadcastMinMaxGetVal (BroadcastMinMaxMessage *msgPtr)
	gets a min/max broadcast message value in msgPtr More...

Detailed Description

Min-Max spanning tree between robots.

Since

April 10, 2013

Author

James McLurkin

Typedef Documentation

typedef struct BroadcastMinMaxMessage BroadcastMinMaxMessage

Broadcast Min-Max Message.

Broadcast message that goes through tree

Function Documentation

void broadcastMinMaxCreate	(	BroadcastMinMaxMessage *	msgPtr,
		char *	name,
		uint8	val
	)

creates a min/max broadcast message in msgPtr

Parameters

msgPtr
name
val	- value to be created

Returns

void

Parameters

msgPtr
name
val

Returns

void

uint8 broadcastMinMaxGetVal

(

BroadcastMinMaxMessage *

msgPtr)

gets a min/max broadcast message value in msgPtr

Parameters

msgPtr

Returns

void

uint8 broadcastMinMaxGetValLocal

(

BroadcastMinMaxMessage *

msgPtr)

gets a min/max broadcast message local value in msgPtr

Parameters

msgPtr

Returns

void

void broadcastMinMaxSet	(	BroadcastMinMaxMessage *	msgPtr,
		uint8	val
	)

creates a min/max broadcast message in msgPtr

Parameters

msgPtr
val	- value to be set

Returns

void

Parameters

msgPtr
val	the maximum number of hops that this message can propagate

Returns

void

void broadcastMinMaxSetMaxPlusOne	(	BroadcastMinMaxMessage *	msgPtr,
		NbrList *	nbrListPtr
	)

creates a min/max broadcast message in msgPtr

Parameters

msgPtr
nbrListPtr

Returns

void

Parameters

msgPtr
nbrListPtr	list of neibors

Returns

void

uint8 broadcastMinMaxUpdate	(	BroadcastMinMaxMessage *	msgPtr,
		NbrList *	nbrListPtr
	)

propagates a min.max message

Parameters

msgPtr
nbrListPtr

Returns

void

Parameters

msgPtr
nbrListPtr	list of neibors

Returns

void