string_parameter.h File Reference

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

Include dependency graph for string_parameter.h:

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

Go to the source code of this file.

Data Structures
struct	StringParameter
struct	StringParameterOption
struct	StringParameterOptionNode

Functions
StringParameter *	AllocateStringParameter (const struct ServiceData *service_data_p, const ParameterType pt, 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)
StringParameter *	AllocateStringParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag, const ParameterType *pt_p)
Parameter *	EasyCreateAndAddStringParameterToParameterSet (const struct ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, ParameterType type, const char *const name_s, const char *const display_name_s, const char *const description_s, const char *default_value_s, uint8 level)
Parameter *	CreateAndAddStringParameterToParameterSet (const struct ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, ParameterType type, const char *const name_s, const char *const display_name_s, const char *const description_s, const char *default_value_s, const char *current_value_s, uint8 level)
void	FreeStringParameter (StringParameter *param_p)
const char *	GetStringParameterCurrentValue (const StringParameter *param_p)
bool	SetStringParameterCurrentValue (StringParameter *param_p, const char *value_p)
const char *	GetStringParameterDefaultValue (const StringParameter *param_p)
bool	SetStringParameterDefaultValue (StringParameter *param_p, const char *value_p)
bool	SetStringParameterBounds (StringParameter *param_p, const char *min_value_s, const char *max_value_s)
bool	IsStringParameterBounded (const StringParameter *param_p)
bool	GetStringParameterBounds (const StringParameter *param_p, const char **min_pp, const char **max_pp)
bool	CreateAndAddStringParameterOption (Parameter *param_p, const char *value_s, const char *description_s)
StringParameterOption *	AllocateStringParameterOption (const char *value_s, const char *description_s)
StringParameterOptionNode *	AllocateStringParameterOptionNode (StringParameterOption *option_p)
void	FreeStringParameterOption (StringParameterOption *option_p)
bool	IsStringParameter (const Parameter *param_p)
bool	GetCurrentStringParameterValueFromParameterGroup (const ParameterGroup *const params_p, const char *const name_s, const char **value_pp)
bool	SetStringParameterCurrentValueFromJSON (StringParameter *param_p, const json_t *value_p)
bool	AddStringParameterOptionsToJSON (const Parameter *param_p, json_t *param_json_p)
bool	GetStringParameterOptionsFromJSON (Parameter *param_p, const json_t *const json_p)
bool	CopyStringParameterOptions (const Parameter *src_p, Parameter *dest_p, const bool clear_existing_dest_options_flag)

Function Documentation

AllocateStringParameter()

StringParameter* AllocateStringParameter	(	const struct ServiceData *	service_data_p,
		const ParameterType	pt,
		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
	)

AllocateStringParameterFromJSON()

StringParameter* AllocateStringParameterFromJSON	(	const json_t *	param_json_p,
		const struct Service *	service_p,
		const bool	concise_flag,
		const ParameterType *	pt_p
	)

EasyCreateAndAddStringParameterToParameterSet()

Parameter* EasyCreateAndAddStringParameterToParameterSet	(	const struct ServiceData *	service_data_p,
		ParameterSet *	params_p,
		ParameterGroup *	group_p,
		ParameterType	type,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		const char *	default_value_s,
		uint8	level
	)

CreateAndAddStringParameterToParameterSet()

Parameter* CreateAndAddStringParameterToParameterSet	(	const struct ServiceData *	service_data_p,
		ParameterSet *	params_p,
		ParameterGroup *	group_p,
		ParameterType	type,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		const char *	default_value_s,
		const char *	current_value_s,
		uint8	level
	)

FreeStringParameter()

void FreeStringParameter

(

StringParameter *

param_p

)

GetStringParameterCurrentValue()

const char* GetStringParameterCurrentValue

(

const StringParameter *

param_p

)

SetStringParameterCurrentValue()

bool SetStringParameterCurrentValue	(	StringParameter *	param_p,
		const char *	value_p
	)

GetStringParameterDefaultValue()

const char* GetStringParameterDefaultValue

(

const StringParameter *

param_p

)

SetStringParameterDefaultValue()

bool SetStringParameterDefaultValue	(	StringParameter *	param_p,
		const char *	value_p
	)

SetStringParameterBounds()

bool SetStringParameterBounds	(	StringParameter *	param_p,
		const char *	min_value_s,
		const char *	max_value_s
	)

IsStringParameterBounded()

bool IsStringParameterBounded

(

const StringParameter *

param_p

)

GetStringParameterBounds()

bool GetStringParameterBounds	(	const StringParameter *	param_p,
		const char **	min_pp,
		const char **	max_pp
	)

CreateAndAddStringParameterOption()

bool CreateAndAddStringParameterOption	(	Parameter *	param_p,
		const char *	value_s,
		const char *	description_s
	)

AllocateStringParameterOption()

StringParameterOption* AllocateStringParameterOption	(	const char *	value_s,
		const char *	description_s
	)

AllocateStringParameterOptionNode()

StringParameterOptionNode* AllocateStringParameterOptionNode

(

StringParameterOption *

option_p

)

FreeStringParameterOption()

void FreeStringParameterOption

(

StringParameterOption *

option_p

)

IsStringParameter()

bool IsStringParameter

(

const Parameter *

param_p

)

GetCurrentStringParameterValueFromParameterGroup()

bool GetCurrentStringParameterValueFromParameterGroup	(	const ParameterGroup *const	params_p,
		const char *const	name_s,
		const char **	value_pp
	)

SetStringParameterCurrentValueFromJSON()

bool SetStringParameterCurrentValueFromJSON	(	StringParameter *	param_p,
		const json_t *	value_p
	)

AddStringParameterOptionsToJSON()

bool AddStringParameterOptionsToJSON	(	const Parameter *	param_p,
		json_t *	param_json_p
	)

GetStringParameterOptionsFromJSON()

bool GetStringParameterOptionsFromJSON	(	Parameter *	param_p,
		const json_t *const	json_p
	)

CopyStringParameterOptions()

bool CopyStringParameterOptions	(	const Parameter *	src_p,
		Parameter *	dest_p,
		const bool	clear_existing_dest_options_flag
	)