Parameter Packing

Handles initializing, packing, unpacking, and console print of Parameter data structures.
More...

Functions
void	initParameters (TaskParameters *params)
	Initializes task parameters with default values.
void	printParameters (const TaskParameters *params, const char *identifier)
	Prints task parameters to the terminal for debugging purposes.
void	packParameters (const TaskParameters *params, char *buffer)
	Packs TaskParameters struct into a byte buffer.
void	unpackParameters (TaskParameters *params, const char *buffer)
	Unpacks byte buffer into TaskParameters struct.
void	updateTag (TaskParameters *params, uint16_t index)
	Updates the tag parameter field, using current value of params->value->orientation.

Detailed Description

Handles initializing, packing, unpacking, and console print of Parameter data structures.

Function Documentation

initParameters()

void initParameters

(

TaskParameters *

params

)

Initializes task parameters with default values.

This function initializes the given task parameters with default values.

Parameters

params

Pointer to the TaskParameters struct to initialize.

packParameters()

void packParameters	(	const TaskParameters *	params,
		char *	buffer )

Packs TaskParameters struct into a byte buffer.

Parameters

params	Pointer to the TaskParameters struct to pack.
buffer	Pointer to the byte buffer where packed data will be stored.

printParameters()

void printParameters	(	const TaskParameters *	params,
		const char *	identifier )

Prints task parameters to the terminal for debugging purposes.

This function prints the given task parameters to the terminal in a human-readable format for debugging purposes.

Parameters

params	Pointer to the TaskParameters struct to print.
identifier	String to use as per-line identifier or formatter to help the console output be readable.

unpackParameters()

void unpackParameters	(	TaskParameters *	params,
		const char *	buffer )

Unpacks byte buffer into TaskParameters struct.

Parameters

params	Pointer to the TaskParameters struct to populate.
buffer	Pointer to the byte buffer containing packed data.

updateTag()

void updateTag	(	TaskParameters *	params,
		uint16_t	index )

Updates the tag parameter field, using current value of params->value->orientation.

Parameters

params	Pointer to the TaskParameters struct to populate.
index	Set index for the current set.