mcl_time_series.h
Go to the documentation of this file.
1 /*!**********************************************************************
2 *
3 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
4 * All rights reserved.
5 *
6 *************************************************************************
7 *
8 * @file mcl_time_series.h
9 * @date Jul 11, 2016
10 * @brief Time series module interface header file.
11 *
12 ************************************************************************/
13 
14 #ifndef MCL_TIME_SERIES_H_
15 #define MCL_TIME_SERIES_H_
16 
17 #include "mcl/mcl_common.h"
18 
19 #ifdef __cplusplus
20 extern "C"
21 {
22 #endif
23 
27  typedef struct mcl_time_series_t mcl_time_series_t;
28 
32  typedef struct mcl_time_series_value_set_t mcl_time_series_value_set_t;
33 
49  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_time_series_new_value_set(mcl_time_series_t *time_series, const char *timestamp, mcl_time_series_value_set_t **value_set);
50 
66  extern MCL_EXPORT E_MCL_ERROR_CODE mcl_time_series_add_value(mcl_time_series_value_set_t *value_set, const char *data_point_id, const char *value,
67  const char *quality_code);
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif //MCL_TIME_SERIES_H_
MCL_EXPORT
#define MCL_EXPORT
Definition: mcl_config_setup.h:43
mcl_common.h
Common module interface header file.
mcl_time_series_add_value
MCL_EXPORT E_MCL_ERROR_CODE mcl_time_series_add_value(mcl_time_series_value_set_t *value_set, const char *data_point_id, const char *value, const char *quality_code)
This function adds data_point_id, value and quality_code to mcl_time_series_value_set_t.
Definition: time_series.c:90
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_time_series_t
struct mcl_time_series_t mcl_time_series_t
This struct is used for building the time series type.
Definition: mcl_time_series.h:27
mcl_time_series_new_value_set
MCL_EXPORT E_MCL_ERROR_CODE mcl_time_series_new_value_set(mcl_time_series_t *time_series, const char *timestamp, mcl_time_series_value_set_t **value_set)
This function creates new value set to be added to mcl_time_series_t.
Definition: time_series.c:55
mcl_time_series_value_set_t
struct mcl_time_series_value_set_t mcl_time_series_value_set_t
This struct is used for building value set of time series.
Definition: mcl_time_series.h:32