unsigned_int_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.
*/
/*
 * unsigned_int_parameter.h
 *
 *  Created on: 31 Jan 2020
 *      Author: billy
 */
 
#ifndef CORE_SHARED_PARAMETERS_INCLUDE_UNSIGNED_INT_PARAMETER_H_
#define CORE_SHARED_PARAMETERS_INCLUDE_UNSIGNED_INT_PARAMETER_H_
 
 
 
#include "parameter.h"
#include "grassroots_service_library.h"
#include "parameter_set.h"
 
 
typedef struct UnsignedIntParameter
{
  Parameter uip_base_param;
 
  uint32 *uip_current_value_p;
 
  uint32 *uip_default_value_p;
 
  uint32 *uip_min_value_p;
 
  uint32 *uip_max_value_p;
 
} UnsignedIntParameter;
 
 
typedef struct UnsignedIntParameterOption
{
  uint32 uipo_value;
 
  char *uipo_description_s;
 
} UnsignedIntParameterOption;
 
 
typedef struct UnsignedIntParameterOptionNode
{
  ListItem uipon_node;
 
  UnsignedIntParameterOption *uipon_option_p;
 
} UnsignedIntParameterOptionNode;
 
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
GRASSROOTS_SERVICE_API UnsignedIntParameter *AllocateUnsignedIntParameter (const struct ServiceData *service_data_p, const char * const name_s, const char * const display_name_s, const char * const description_s, const uint32 *default_value_p, const uint32 *current_value_p, ParameterLevel level);
 
 
GRASSROOTS_SERVICE_API UnsignedIntParameter *AllocateUnsignedIntParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag);
 
 
GRASSROOTS_SERVICE_API Parameter *EasyCreateAndAddUnsignedIntParameterToParameterSet (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 uint32 *default_value_p, uint8 level);
 
 
 
GRASSROOTS_SERVICE_API Parameter *CreateAndAddUnsignedIntParameterToParameterSet (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 uint32 *default_value_p, const uint32 *current_value_p, uint8 level);
 
 
GRASSROOTS_SERVICE_API void FreeUnsignedIntParameter (UnsignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API const uint32 *GetUnsignedIntParameterCurrentValue (const UnsignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetUnsignedIntParameterCurrentValue (UnsignedIntParameter *param_p, const uint32 *value_p);
 
 
GRASSROOTS_SERVICE_API const uint32 *GetUnsignedIntParameterDefaultValue (const UnsignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetUnsignedIntParameterDefaultValue (UnsignedIntParameter *param_p, const uint32 *value_p);
 
 
GRASSROOTS_SERVICE_API bool SetUnsignedIntParameterBounds (UnsignedIntParameter *param_p, const uint32 min_value, const uint32 max_value);
 
 
GRASSROOTS_SERVICE_API bool IsUnsignedIntParameterBounded (const UnsignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API void GetUnsignedIntParameterBounds (const UnsignedIntParameter *param_p, const uint32 **min_pp, const uint32 **max_pp);
 
 
GRASSROOTS_SERVICE_API bool IsUnsignedIntParameter (const Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool GetCurrentUnsignedIntParameterValueFromParameterSet (const ParameterSet * const params_p, const char * const name_s, const uint32 **value_pp);
 
 
GRASSROOTS_SERVICE_API bool CreateAndAddUnsignedIntParameterOption (UnsignedIntParameter *param_p, const uint32 value, const char *description_s);
 
 
GRASSROOTS_SERVICE_API UnsignedIntParameterOption *AllocateUnsignedIntParameterOption (const uint32 value, const char *description_s);
 
 
GRASSROOTS_SERVICE_API void FreeUnsignedIntParameterOption (UnsignedIntParameterOption *option_p);
 
 
GRASSROOTS_SERVICE_API UnsignedIntParameterOptionNode *AllocateUnsignedIntParameterOptionNode (UnsignedIntParameterOption *option_p);
 
 
GRASSROOTS_SERVICE_API void FreeStringParameterOptionNode (ListItem *item_p);
 
 
GRASSROOTS_SERVICE_API bool SetUnsignedIntParameterCurrentValueFromJSON (UnsignedIntParameter *param_p, const json_t *value_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CORE_SHARED_PARAMETERS_INCLUDE_UNSIGNED_INT_PARAMETER_H_ */