mcl_data_source_configuration.h
Go to the documentation of this file.
1 /*!**********************************************************************
2 *
3 * @copyright Copyright (C) 2017 Siemens Aktiengesellschaft.\n
4 * All rights reserved.
5 *
6 *************************************************************************
7 *
8 * @file mcl_data_source_configuration.h
9 * @date Nov 13, 2017
10 * @brief Data source configuration module interface header file.
11 *
12 * Meta and payload parts of data source configuration type are initialized and set by this module.
13 *
14 ************************************************************************/
15 
16 #ifndef MCL_DATA_SOURCE_CONFIGURATION_H_
17 #define MCL_DATA_SOURCE_CONFIGURATION_H_
18 
19 #include "mcl/mcl_common.h"
20 #include "mcl/mcl_random.h"
21 
22 #ifdef __cplusplus
23 extern "C"
24 {
25 #endif
26 
30  typedef struct mcl_data_source_configuration_t mcl_data_source_configuration_t;
31 
35  typedef struct mcl_data_source_t mcl_data_source_t;
36 
40  typedef struct mcl_json_t mcl_json_t;
41 
59  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_data_source_configuration_add_data_source(mcl_data_source_configuration_t *data_source_configuration, const char *name,
60  const char *description, mcl_json_t *custom_data, mcl_data_source_t **data_source);
61 
81  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_data_source_configuration_add_data_point(mcl_data_source_t *data_source, const char *id, const char *name, const char *description,
82  const char *type, const char *unit, mcl_json_t *custom_data);
83 
98  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_data_source_configuration_get_id(mcl_data_source_configuration_t *data_source_configuration, char **id);
99 
100 
101 #ifdef __cplusplus
102 }
103 #endif
104 
105 #endif //MCL_DATA_SOURCE_CONFIGURATION_H_
mcl_json_t
struct mcl_json_t mcl_json_t
This struct is used for json handling.
Definition: mcl_custom_data.h:34
mcl_data_source_configuration_t
struct mcl_data_source_configuration_t mcl_data_source_configuration_t
Definition: mcl_data_source_configuration.h:30
MCL_EXPORT
#define MCL_EXPORT
Definition: mcl_config_setup.h:43
mcl_common.h
Common module interface header file.
E_MCL_ERROR_CODE
E_MCL_ERROR_CODE
MCL Error code definitions. Every function returning an error code uses this enum values...
Definition: mcl_common.h:137
mcl_data_source_configuration_add_data_point
MCL_EXPORT E_MCL_ERROR_CODE mcl_data_source_configuration_add_data_point(mcl_data_source_t *data_source, const char *id, const char *name, const char *description, const char *type, const char *unit, mcl_json_t *custom_data)
Definition: data_source_configuration.c:113
mcl_data_source_configuration_add_data_source
MCL_EXPORT E_MCL_ERROR_CODE mcl_data_source_configuration_add_data_source(mcl_data_source_configuration_t *data_source_configuration, const char *name, const char *description, mcl_json_t *custom_data, mcl_data_source_t **data_source)
Definition: data_source_configuration.c:60
mcl_data_source_configuration_get_id
MCL_EXPORT E_MCL_ERROR_CODE mcl_data_source_configuration_get_id(mcl_data_source_configuration_t *data_source_configuration, char **id)
Definition: data_source_configuration.c:177
mcl_random.h
Random number generation module interface header file.
mcl_data_source_t
struct mcl_data_source_t mcl_data_source_t
Definition: mcl_data_source_configuration.h:35