time_parameter.h

Go to the documentation of this file.

/*
** Copyright 2014-2020 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
/*
 * time_parameter.h
 *
 *  Created on: 31 Jan 2020
 *      Author: billy
 */
 
#ifndef CORE_SHARED_PARAMETERS_INCLUDE_TIME_PARAMETER_H_
#define CORE_SHARED_PARAMETERS_INCLUDE_TIME_PARAMETER_H_
 
 
#include "parameter.h"
#include "grassroots_service_library.h"
#include "time.h"
#include "parameter_set.h"
 
 
 
typedef struct TimeParameter
{
  Parameter tp_base_param;
 
  struct tm *tp_current_value_p;
 
  struct tm *tp_default_value_p;
 
  struct tm *tp_min_value_p;
 
  struct tm *tp_max_value_p;
 
} TimeParameter;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
GRASSROOTS_SERVICE_API TimeParameter *AllocateTimeParameter (const struct ServiceData *service_data_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,
                                                            ParameterLevel level);
 
 
GRASSROOTS_SERVICE_API TimeParameter *AllocateTimeParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag);
 
 
GRASSROOTS_SERVICE_API 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);
 
GRASSROOTS_SERVICE_API 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);
 
 
GRASSROOTS_SERVICE_API void FreeTimeParameter (TimeParameter *param_p);
 
 
GRASSROOTS_SERVICE_API const struct tm *GetTimeParameterCurrentValue (const TimeParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetTimeParameterCurrentValue (TimeParameter *param_p, const struct tm *value_p);
 
 
GRASSROOTS_SERVICE_API const struct tm *GetTimeParameterDefaultValue (const TimeParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetTimeParameterDefaultValue (TimeParameter *param_p, const struct tm *value_p);
 
 
GRASSROOTS_SERVICE_API bool IsTimeParameter (Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool GetCurrentTimeParameterValueFromParameterSet (const ParameterSet * const params_p, const char * const name_s, const struct tm **value_pp);
 
 
GRASSROOTS_SERVICE_API bool SetTimeParameterCurrentValueFromJSON (TimeParameter *param_p, const json_t *value_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
 
#endif /* CORE_SHARED_PARAMETERS_INCLUDE_TIME_PARAMETER_H_ */