boolean_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.
*/
/*
 * boolean_parameter.h
 *
 *  Created on: 30 Jan 2020
 *      Author: billy
 */
 
#ifndef CORE_SHARED_PARAMETERS_INCLUDE_BOOLEAN_PARAMETER_H_
#define CORE_SHARED_PARAMETERS_INCLUDE_BOOLEAN_PARAMETER_H_
 
#include "parameter.h"
#include "grassroots_service_library.h"
#include "parameter_set.h"
 
 
/* forward declaration */
struct ServiceData;
 
typedef struct BooleanParameter
{
  Parameter bp_base_param;
 
  bool *bp_current_value_p;
 
  bool *bp_default_value_p;
} BooleanParameter;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
GRASSROOTS_SERVICE_API BooleanParameter *AllocateBooleanParameter (const struct ServiceData *service_data_p, const char * const name_s, const char * const display_name_s, const char * const description_s, const bool *default_value_p, const bool *current_value_p, ParameterLevel level);
 
 
GRASSROOTS_SERVICE_API BooleanParameter *AllocateBooleanParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag);
 
 
GRASSROOTS_SERVICE_API Parameter *EasyCreateAndAddBooleanParameterToParameterSet (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 bool *default_value_p, uint8 level);
 
 
 
GRASSROOTS_SERVICE_API Parameter *CreateAndAddBooleanParameterToParameterSet (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 bool *default_value_p, const bool *current_value_p, uint8 level);
 
 
GRASSROOTS_SERVICE_API void FreeBooleanParameter (BooleanParameter *param_p);
 
 
GRASSROOTS_SERVICE_API const bool *GetBooleanParameterCurrentValue (const BooleanParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetBooleanParameterCurrentValue (BooleanParameter *param_p, const bool *value_p);
 
 
GRASSROOTS_SERVICE_API const bool *GetBooleanParameterDefaultValue (const BooleanParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetBooleanParameterDefaultValue (BooleanParameter *param_p, const bool *value_p);
 
 
GRASSROOTS_SERVICE_API bool IsBooleanParameter (const Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool GetCurrentBooleanParameterValueFromParameterSet (const ParameterSet * const params_p, const char * const name_s, const bool **value_pp);
 
 
GRASSROOTS_SERVICE_API bool SetBooleanParameterCurrentValueFromJSON (BooleanParameter *param_p, const json_t *value_p);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
 
 
#endif /* CORE_SHARED_PARAMETERS_INCLUDE_BOOLEAN_PARAMETER_H_ */