parameter_set.h

Go to the documentation of this file.

/*
L** Copyright 2014-2016 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.
*/
 
#ifndef PARAMETER_SET_H
#define PARAMETER_SET_H
 
#include "jansson.h"
 
#include "linked_list.h"
#include "parameter.h"
#include "json_util.h"
 
 
struct ServiceData;
struct Service;
 
#include "parameter_group.h"
 
 
typedef struct ParameterSet
{
  const char *ps_name_s;
 
  const char *ps_description_s;
 
  LinkedList *ps_params_p;
 
  LinkedList *ps_grouped_params_p;
 
  ParameterLevel ps_current_level;
} ParameterSet;
 
 
typedef struct ParameterSetNode
{
  ListItem psn_node;
 
  ParameterSet *psn_param_set_p;
} ParameterSetNode;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
GRASSROOTS_SERVICE_API ParameterSet *AllocateParameterSet (const char *name_s, const char *description_s);
 
 
GRASSROOTS_SERVICE_API void FreeParameterSet (ParameterSet *params_p);
 
 
GRASSROOTS_SERVICE_API bool AddParameterToParameterSet (ParameterSet *params_p, Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API bool ReplaceParameterInParameterSet (ParameterSet *params_p, Parameter *old_param_p, Parameter *new_param_p, const bool free_old_param_flag);
 
 
GRASSROOTS_SERVICE_API json_t *GetParameterSetAsJSON (const ParameterSet * const param_set_p, const SchemaVersion * const sv_p, const bool full_definition_flag);
 
 
 
 
GRASSROOTS_SERVICE_API json_t *GetParameterSetSelectionAsJSON (const ParameterSet * const param_set_p, const SchemaVersion * const sv_p, const bool full_definition_flag, void *data_p, bool (*add_param_fn) (const Parameter *param_p, void *data_p));
 
 
GRASSROOTS_SERVICE_API ParameterSet *CreateParameterSetFromJSON (const json_t * const json_p, struct Service *service_p, const bool concise_flag);
 
 
GRASSROOTS_SERVICE_API Parameter *GetParameterFromParameterSetByName (const ParameterSet * const params_p, const char * const name_s);
 
 
GRASSROOTS_SERVICE_API ParameterNode *GetParameterNodeFromParameterSetByName (const ParameterSet * const params_p, const char * const name_s);
 
 
 
GRASSROOTS_SERVICE_API ParameterSetNode *AllocateParameterSetNode (ParameterSet *params_p);
 
 
GRASSROOTS_SERVICE_API void FreeParameterSetNode (ListItem *node_p);
 
 
 
GRASSROOTS_SERVICE_API Parameter *DetachParameterByName (ParameterSet *params_p, const char * const name_s);
 
 
 
GRASSROOTS_SERVICE_API bool DetachParameter (ParameterSet *params_p, Parameter *param_p);
 
 
GRASSROOTS_SERVICE_API struct ParameterGroup *GetParameterGroupFromParameterSetByGroupName (const ParameterSet * const params_p, const char * const name_s);
 
 
GRASSROOTS_SERVICE_API bool AddParameterGroupToParameterSet (ParameterSet *param_set_p, ParameterGroup *group_p);
 
 
GRASSROOTS_SERVICE_API uint32 GetParameterSetSize (const ParameterSet * const param_set_p);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif    /* #ifndef PARAMETER_SET_H */