treatment_factor.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.
*/
/*
 * treatment_factor..h
 *
 *  Created on: 4 Dec 2020
 *      Author: billy
 */
 
#ifndef SERVICES_FIELD_TRIALS_INCLUDE_TREATMENT_FACTOR_H_
#define SERVICES_FIELD_TRIALS_INCLUDE_TREATMENT_FACTOR_H_
 
 
#include "dfw_field_trial_service_library.h"
#include "dfw_field_trial_service_data.h"
 
#include "treatment.h"
#include "linked_list.h"
 
 
/* forward declarations */
struct Study;
 
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_TREATMENT_FACTOR_TAGS
  #define TREATMENT_FACTOR_PREFIX DFW_FIELD_TRIAL_SERVICE_LOCAL
  #define TREATMENT_FACTOR_VAL(x) = x
  #define TREATMENT_FACTOR_CONCAT_VAL(x,y)  = x y
#else
  #define TREATMENT_FACTOR_PREFIX extern
  #define TREATMENT_FACTOR_VAL(x)
  #define TREATMENT_FACTOR_CONCAT_VAL(x,y)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
 
 
 
 
TREATMENT_FACTOR_PREFIX const char *TF_STUDY_ID_S TREATMENT_FACTOR_VAL("study_id");
TREATMENT_FACTOR_PREFIX const char *TF_STUDY_NAME_S TREATMENT_FACTOR_VAL ("study_name");
TREATMENT_FACTOR_PREFIX const char *TF_TREATMENT_S TREATMENT_FACTOR_VAL ( "treatment");
TREATMENT_FACTOR_PREFIX const char *TF_TREATMENT_ID_S TREATMENT_FACTOR_VAL ("treatment_id");
TREATMENT_FACTOR_PREFIX const char *TF_VALUES_S TREATMENT_FACTOR_VAL ("values");
TREATMENT_FACTOR_PREFIX const char *TF_VALUES_KEY_S TREATMENT_FACTOR_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "name");
TREATMENT_FACTOR_PREFIX const char *TF_VALUES_VALUE_S TREATMENT_FACTOR_VAL ("value");
 
 
 
 
 
typedef struct TreatmentFactor
{
  Treatment *tf_treatment_p;
 
  struct Study *tf_study_p;
 
  LinkedList *tf_values_p;
 
} TreatmentFactor;
 
 
typedef struct TreatmentFactorNode
{
  ListItem tfn_node;
 
  TreatmentFactor *tfn_p;
} TreatmentFactorNode;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
DFW_FIELD_TRIAL_SERVICE_LOCAL TreatmentFactor *AllocateTreatmentFactor (Treatment *treatment_factor_p, struct Study *study_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL void FreeTreatmentFactor (TreatmentFactor *treatment_factor_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL bool AddTreatmentFactorValue (TreatmentFactor *treatment_p, const char *name_s, const char *value_s);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL TreatmentFactorNode *AllocateTreatmentFactorNode (TreatmentFactor *treatment_factor_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL void FreeTreatmentFactorNode (ListItem *treatment_node_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL size_t *GetNumberOfTreatmentFactorValues (const TreatmentFactor *treatment_factor_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL json_t *GetTreatmentFactorAsJSON (const TreatmentFactor *treatment_factor_p, const ViewFormat format);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL TreatmentFactor *GetTreatmentFactorFromJSON (const json_t *treatment_factor_json_p, struct Study *parent_study_p, const FieldTrialServiceData *data_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL const char *GetTreatmentFactorValue (TreatmentFactor *treatment_p, const char *name_s);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL const char *GetTreatmentFactorName (const TreatmentFactor *treatment_factor_p);
 
 
DFW_FIELD_TRIAL_SERVICE_LOCAL const char *GetTreatmentFactorUrl (const TreatmentFactor *treatment_factor_p);
 
DFW_FIELD_TRIAL_SERVICE_LOCAL const char *GetTreatmentFactorDescription (const TreatmentFactor *treatment_factor_p);
 
 
 
DFW_FIELD_TRIAL_SERVICE_LOCAL json_t *GetTreatmentFactorValuesAsJSON (const TreatmentFactor *treatment_factor_p, const ViewFormat format);
 
 
 
 
 
#ifdef _cplusplus
}
#endif
 
 
#endif /* SERVICES_FIELD_TRIALS_INCLUDE_TREATMENT_FACTOR_H_ */