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 time_series.h
9 * @date Sep 26, 2016
10 * @brief Time series module header file.
11 *
12 ************************************************************************/
13 
14 #ifndef TIME_SERIES_H_
15 #define TIME_SERIES_H_
16 
17 #include "data_types.h"
18 
22 typedef struct mcl_time_series_t
23 {
24  item_meta_t meta;
25  time_series_payload_t payload;
26 } time_series_t;
27 
43 E_MCL_ERROR_CODE time_series_initialize(const char *version, const char *configuration_id, const char *routing, time_series_t **time_series);
44 
52 void time_series_destroy(time_series_t **time_series);
53 
54 #endif //TIME_SERIES_H_
time_series_initialize
E_MCL_ERROR_CODE time_series_initialize(const char *version, const char *configuration_id, const char *routing, time_series_t **time_series)
This function creates and initializes a data struct of time_series_t.
Definition: time_series.c:26
time_series_payload_t
This struct is used for building the payload of time series which is list of value sets...
Definition: data_types.h:121
time_series_t::payload
time_series_payload_t payload
Payload of time series.
Definition: time_series.h:25
time_series_t
This struct is used for building the complete message of time series event.
Definition: time_series.h:22
time_series_t
struct mcl_time_series_t time_series_t
Definition: data_types.h:21
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
item_meta_t
This struct is used for building item.meta structure.
Definition: data_types.h:84
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
time_series_t::meta
item_meta_t meta
Meta of time series.
Definition: time_series.h:24
data_types.h
Data types module header file.
time_series_destroy
void time_series_destroy(time_series_t **time_series)
To destroy the time_series_t data struct.
Definition: time_series.c:123