char_parameter.h File Reference

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

Include dependency graph for char_parameter.h:

Go to the source code of this file.

Data Structures
struct	CharParameter

Functions
CharParameter *	AllocateCharParameter (const struct ServiceData *service_data_p, const char *const name_s, const char *const display_name_s, const char *const description_s, const char *default_value_p, const char *current_value_p, ParameterLevel level)
CharParameter *	AllocateCharParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag)
void	FreeCharParameter (CharParameter *param_p)
const char *	GetCharParameterCurrentValue (const CharParameter *param_p)
bool	SetCharParameterCurrentValue (CharParameter *param_p, const char *value_p)
const char *	GetCharParameterDefaultValue (const CharParameter *param_p)
bool	SetCharParameterDefaultValue (CharParameter *param_p, const char *value_p)
bool	SetCharParameterBounds (CharParameter *param_p, const char min_value, const char max_value)
bool	IsCharParameterBounded (const CharParameter *param_p)
bool	GetCharParameterBounds (const CharParameter *param_p, char *min_p, char *max_p)
bool	IsCharParameter (Parameter *param_p)
bool	GetCurrentCharParameterValueFromParameterSet (const ParameterSet *const params_p, const char *const name_s, const char **value_pp)
Parameter *	EasyCreateAndAddCharParameterToParameterSet (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 char *default_value_p, uint8 level)
Parameter *	CreateAndAddCharParameterToParameterSet (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 char *default_value_p, const char *current_value_p, uint8 level)
bool	SetCharParameterCurrentValueFromJSON (CharParameter *param_p, const json_t *value_p)

Function Documentation

AllocateCharParameter()

CharParameter* AllocateCharParameter	(	const struct ServiceData *	service_data_p,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		const char *	default_value_p,
		const char *	current_value_p,
		ParameterLevel	level
	)

AllocateCharParameterFromJSON()

CharParameter* AllocateCharParameterFromJSON	(	const json_t *	param_json_p,
		const struct Service *	service_p,
		const bool	concise_flag
	)

FreeCharParameter()

void FreeCharParameter

(

CharParameter *

param_p

)

GetCharParameterCurrentValue()

const char* GetCharParameterCurrentValue

(

const CharParameter *

param_p

)

SetCharParameterCurrentValue()

bool SetCharParameterCurrentValue	(	CharParameter *	param_p,
		const char *	value_p
	)

GetCharParameterDefaultValue()

const char* GetCharParameterDefaultValue

(

const CharParameter *

param_p

)

SetCharParameterDefaultValue()

bool SetCharParameterDefaultValue	(	CharParameter *	param_p,
		const char *	value_p
	)

SetCharParameterBounds()

bool SetCharParameterBounds	(	CharParameter *	param_p,
		const char	min_value,
		const char	max_value
	)

IsCharParameterBounded()

bool IsCharParameterBounded

(

const CharParameter *

param_p

)

GetCharParameterBounds()

bool GetCharParameterBounds	(	const CharParameter *	param_p,
		char *	min_p,
		char *	max_p
	)

IsCharParameter()

bool IsCharParameter

(

Parameter *

param_p

)

GetCurrentCharParameterValueFromParameterSet()

bool GetCurrentCharParameterValueFromParameterSet	(	const ParameterSet *const	params_p,
		const char *const	name_s,
		const char **	value_pp
	)

EasyCreateAndAddCharParameterToParameterSet()

Parameter* EasyCreateAndAddCharParameterToParameterSet	(	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 char *	default_value_p,
		uint8	level
	)

CreateAndAddCharParameterToParameterSet()

Parameter* CreateAndAddCharParameterToParameterSet	(	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 char *	default_value_p,
		const char *	current_value_p,
		uint8	level
	)

SetCharParameterCurrentValueFromJSON()

bool SetCharParameterCurrentValueFromJSON	(	CharParameter *	param_p,
		const json_t *	value_p
	)