time_parameter.h File Reference

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

Include dependency graph for time_parameter.h:

Go to the source code of this file.

Data Structures
struct	TimeParameter

Functions
TimeParameter *	AllocateTimeParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag)
Parameter *	EasyCreateAndAddTimeParameterToParameterSet (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 struct tm *default_value_p, uint8 level)
Parameter *	CreateAndAddTimeParameterToParameterSet (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 struct tm *default_value_p, const struct tm *current_value_p, uint8 level)
void	FreeTimeParameter (TimeParameter *param_p)
const struct tm *	GetTimeParameterCurrentValue (const TimeParameter *param_p)
bool	SetTimeParameterCurrentValue (TimeParameter *param_p, const struct tm *value_p)
const struct tm *	GetTimeParameterDefaultValue (const TimeParameter *param_p)
bool	SetTimeParameterDefaultValue (TimeParameter *param_p, const struct tm *value_p)
bool	IsTimeParameter (Parameter *param_p)
bool	GetCurrentTimeParameterValueFromParameterSet (const ParameterSet *const params_p, const char *const name_s, const struct tm **value_pp)
bool	SetTimeParameterCurrentValueFromJSON (TimeParameter *param_p, const json_t *value_p)

Function Documentation

AllocateTimeParameterFromJSON()

TimeParameter* AllocateTimeParameterFromJSON	(	const json_t *	param_json_p,
		const struct Service *	service_p,
		const bool	concise_flag
	)

EasyCreateAndAddTimeParameterToParameterSet()

Parameter* EasyCreateAndAddTimeParameterToParameterSet	(	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 struct tm *	default_value_p,
		uint8	level
	)

CreateAndAddTimeParameterToParameterSet()

Parameter* CreateAndAddTimeParameterToParameterSet	(	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 struct tm *	default_value_p,
		const struct tm *	current_value_p,
		uint8	level
	)

FreeTimeParameter()

void FreeTimeParameter

(

TimeParameter *

param_p

)

GetTimeParameterCurrentValue()

const struct tm* GetTimeParameterCurrentValue

(

const TimeParameter *

param_p

)

SetTimeParameterCurrentValue()

bool SetTimeParameterCurrentValue	(	TimeParameter *	param_p,
		const struct tm *	value_p
	)

GetTimeParameterDefaultValue()

const struct tm* GetTimeParameterDefaultValue

(

const TimeParameter *

param_p

)

SetTimeParameterDefaultValue()

bool SetTimeParameterDefaultValue	(	TimeParameter *	param_p,
		const struct tm *	value_p
	)

IsTimeParameter()

bool IsTimeParameter

(

Parameter *

param_p

)

GetCurrentTimeParameterValueFromParameterSet()

bool GetCurrentTimeParameterValueFromParameterSet	(	const ParameterSet *const	params_p,
		const char *const	name_s,
		const struct tm **	value_pp
	)

SetTimeParameterCurrentValueFromJSON()

bool SetTimeParameterCurrentValueFromJSON	(	TimeParameter *	param_p,
		const json_t *	value_p
	)