signed_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.
*/
/*
 * signed_int_parameter.h
 *
 *  Created on: 30 Jan 2020
 *      Author: billy
 */
 
#ifndef CORE_SHARED_PARAMETERS_INCLUDE_SIGNED_INT_PARAMETER_H_
#define CORE_SHARED_PARAMETERS_INCLUDE_SIGNED_INT_PARAMETER_H_
 
 
 
#include "parameter.h"
#include "grassroots_service_library.h"
#include "parameter_set.h"
 
 
typedef struct SignedIntParameter
{
  Parameter sip_base_param;
 
  int32 *sip_current_value_p;
 
  int32 *sip_default_value_p;
 
  int32 *sip_min_value_p;
 
  int32 *sip_max_value_p;
 
} SignedIntParameter;
 
 
typedef struct SignedIntParameterOption
{
  int32 sipo_value;
 
  char *sipo_description_s;
 
} SignedIntParameterOption;
 
 
 
typedef struct SignedIntParameterOptionNode
{
  ListItem sipon_node;
 
  SignedIntParameterOption *sipon_option_p;
 
} SignedIntParameterOptionNode;
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
GRASSROOTS_SERVICE_API SignedIntParameter *AllocateSignedIntParameter (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 int32 *default_value_p, const int32 *current_value_p,
                                                                      ParameterLevel level);
 
 
GRASSROOTS_SERVICE_API SignedIntParameter *AllocateSignedIntParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag);
 
 
 
GRASSROOTS_SERVICE_API void FreeSignedIntParameter (SignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API Parameter *EasyCreateAndAddSignedIntParameterToParameterSet (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 int32 *default_value_p, uint8 level);
 
 
GRASSROOTS_SERVICE_API Parameter *CreateAndAddSignedIntParameterToParameterSet (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 int32 *default_value_p, const int32 *current_value_p, uint8 level);
 
 
GRASSROOTS_SERVICE_API const int32 *GetSignedIntParameterCurrentValue (const SignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetSignedIntParameterCurrentValue (SignedIntParameter *param_p, const int32 *value_p);
 
 
GRASSROOTS_SERVICE_API const int32 *GetSignedIntParameterDefaultValue (const SignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool SetSignedIntParameterDefaultValue (SignedIntParameter *param_p, const int32 *value_p);
 
 
GRASSROOTS_SERVICE_API bool SetSignedIntParameterBounds (SignedIntParameter *param_p, const int32 min_value, const int32 max_value);
 
 
GRASSROOTS_SERVICE_API bool IsSignedIntParameterBounded (const SignedIntParameter *param_p);
 
 
GRASSROOTS_SERVICE_API void GetSignedIntParameterBounds (const SignedIntParameter *param_p, const int32 **min_pp, const int32 **max_pp);
 
 
GRASSROOTS_SERVICE_API bool IsSignedIntParameter (const Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool GetCurrentSignedIntParameterValueFromParameterSet (const ParameterSet * const params_p, const char * const name_s, const int32 **value_pp);
 
 
GRASSROOTS_SERVICE_API bool CreateAndAddSignedIntParameterOption (SignedIntParameter *param_p, const int32 value, const char *description_s);
 
 
GRASSROOTS_SERVICE_API SignedIntParameterOption *AllocateSignedIntParameterOption (const int32 value, const char *description_s);
 
 
GRASSROOTS_SERVICE_API void FreeSignedIntParameterOption (SignedIntParameterOption *option_p);
 
 
GRASSROOTS_SERVICE_API SignedIntParameterOptionNode *AllocateSignedIntParameterOptionNode (SignedIntParameterOption *option_p);
 
 
GRASSROOTS_SERVICE_API void FreeStringParameterOptionNode (ListItem *item_p);
 
 
GRASSROOTS_SERVICE_API bool SetSignedIntParameterCurrentValueFromJSON (SignedIntParameter *param_p, const json_t *value_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CORE_SHARED_PARAMETERS_INCLUDE_SIGNED_INT_PARAMETER_H_ */