unsigned_int_parameter.h File Reference

#include "parameter.h"
#include "grassroots_service_library.h"
#include "parameter_set.h"

Include dependency graph for unsigned_int_parameter.h:

Go to the source code of this file.

Data Structures
struct	UnsignedIntParameter
struct	UnsignedIntParameterOption
struct	UnsignedIntParameterOptionNode

Functions
UnsignedIntParameter *	AllocateUnsignedIntParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag)
Parameter *	EasyCreateAndAddUnsignedIntParameterToParameterSet (const struct ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, const char *const name_s, const char *const display_name_s, const char *const description_s, const uint32 *default_value_p, uint8 level)
Parameter *	CreateAndAddUnsignedIntParameterToParameterSet (const struct ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, const char *const name_s, const char *const display_name_s, const char *const description_s, const uint32 *default_value_p, const uint32 *current_value_p, uint8 level)
void	FreeUnsignedIntParameter (UnsignedIntParameter *param_p)
const uint32 *	GetUnsignedIntParameterCurrentValue (const UnsignedIntParameter *param_p)
bool	SetUnsignedIntParameterCurrentValue (UnsignedIntParameter *param_p, const uint32 *value_p)
const uint32 *	GetUnsignedIntParameterDefaultValue (const UnsignedIntParameter *param_p)
bool	SetUnsignedIntParameterDefaultValue (UnsignedIntParameter *param_p, const uint32 *value_p)
bool	SetUnsignedIntParameterBounds (UnsignedIntParameter *param_p, const uint32 min_value, const uint32 max_value)
bool	IsUnsignedIntParameterBounded (const UnsignedIntParameter *param_p)
void	GetUnsignedIntParameterBounds (const UnsignedIntParameter *param_p, const uint32 **min_pp, const uint32 **max_pp)
bool	IsUnsignedIntParameter (const Parameter *param_p)
bool	GetCurrentUnsignedIntParameterValueFromParameterSet (const ParameterSet *const params_p, const char *const name_s, const uint32 **value_pp)
bool	CreateAndAddUnsignedIntParameterOption (UnsignedIntParameter *param_p, const uint32 value, const char *description_s)
UnsignedIntParameterOption *	AllocateUnsignedIntParameterOption (const uint32 value, const char *description_s)
void	FreeUnsignedIntParameterOption (UnsignedIntParameterOption *option_p)
UnsignedIntParameterOptionNode *	AllocateUnsignedIntParameterOptionNode (UnsignedIntParameterOption *option_p)
void	FreeStringParameterOptionNode (ListItem *item_p)
bool	SetUnsignedIntParameterCurrentValueFromJSON (UnsignedIntParameter *param_p, const json_t *value_p)

Function Documentation

AllocateUnsignedIntParameterFromJSON()

UnsignedIntParameter* AllocateUnsignedIntParameterFromJSON	(	const json_t *	param_json_p,
		const struct Service *	service_p,
		const bool	concise_flag
	)

EasyCreateAndAddUnsignedIntParameterToParameterSet()

Parameter* EasyCreateAndAddUnsignedIntParameterToParameterSet	(	const struct ServiceData *	service_data_p,
		ParameterSet *	params_p,
		ParameterGroup *	group_p,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		const uint32 *	default_value_p,
		uint8	level
	)

CreateAndAddUnsignedIntParameterToParameterSet()

Parameter* CreateAndAddUnsignedIntParameterToParameterSet	(	const struct ServiceData *	service_data_p,
		ParameterSet *	params_p,
		ParameterGroup *	group_p,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		const uint32 *	default_value_p,
		const uint32 *	current_value_p,
		uint8	level
	)

FreeUnsignedIntParameter()

void FreeUnsignedIntParameter

(

UnsignedIntParameter *

param_p

)

GetUnsignedIntParameterCurrentValue()

const uint32* GetUnsignedIntParameterCurrentValue

(

const UnsignedIntParameter *

param_p

)

SetUnsignedIntParameterCurrentValue()

bool SetUnsignedIntParameterCurrentValue	(	UnsignedIntParameter *	param_p,
		const uint32 *	value_p
	)

GetUnsignedIntParameterDefaultValue()

const uint32* GetUnsignedIntParameterDefaultValue

(

const UnsignedIntParameter *

param_p

)

SetUnsignedIntParameterDefaultValue()

bool SetUnsignedIntParameterDefaultValue	(	UnsignedIntParameter *	param_p,
		const uint32 *	value_p
	)

SetUnsignedIntParameterBounds()

bool SetUnsignedIntParameterBounds	(	UnsignedIntParameter *	param_p,
		const uint32	min_value,
		const uint32	max_value
	)

IsUnsignedIntParameterBounded()

bool IsUnsignedIntParameterBounded

(

const UnsignedIntParameter *

param_p

)

GetUnsignedIntParameterBounds()

void GetUnsignedIntParameterBounds	(	const UnsignedIntParameter *	param_p,
		const uint32 **	min_pp,
		const uint32 **	max_pp
	)

IsUnsignedIntParameter()

bool IsUnsignedIntParameter

(

const Parameter *

param_p

)

GetCurrentUnsignedIntParameterValueFromParameterSet()

bool GetCurrentUnsignedIntParameterValueFromParameterSet	(	const ParameterSet *const	params_p,
		const char *const	name_s,
		const uint32 **	value_pp
	)

CreateAndAddUnsignedIntParameterOption()

bool CreateAndAddUnsignedIntParameterOption	(	UnsignedIntParameter *	param_p,
		const uint32	value,
		const char *	description_s
	)

AllocateUnsignedIntParameterOption()

UnsignedIntParameterOption* AllocateUnsignedIntParameterOption	(	const uint32	value,
		const char *	description_s
	)

FreeUnsignedIntParameterOption()

void FreeUnsignedIntParameterOption

(

UnsignedIntParameterOption *

option_p

)

AllocateUnsignedIntParameterOptionNode()

UnsignedIntParameterOptionNode* AllocateUnsignedIntParameterOptionNode

(

UnsignedIntParameterOption *

option_p

)

FreeStringParameterOptionNode()

void FreeStringParameterOptionNode

(

ListItem *

item_p

)

SetUnsignedIntParameterCurrentValueFromJSON()

bool SetUnsignedIntParameterCurrentValueFromJSON	(	UnsignedIntParameter *	param_p,
		const json_t *	value_p
	)