1 /*
2 * SysDB - src/include/core/timeseries.h
3 * Copyright (C) 2014 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_CORE_TIMESERIES_H
29 #define SDB_CORE_TIMESERIES_H 1
31 #include "sysdb.h"
32 #include "core/time.h"
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
38 /*
39 * A data-point describes a datum at a certain point of time.
40 */
41 typedef struct {
42 sdb_time_t timestamp;
43 double value;
44 } sdb_data_point_t;
46 /*
47 * A timeseries describes one or more sequences of data-points. Multiple
48 * sequences will have a name each and share the same start and end times and
49 * number of data points.
50 *
51 * Start and end times may diverge slightly from the requested start and end
52 * times depending on the resolution available in the backend data-store.
53 */
54 typedef struct {
55 sdb_time_t start;
56 sdb_time_t end;
58 sdb_data_point_t **data;
59 size_t data_len;
60 char **data_names;
61 size_t data_names_len;
62 } sdb_timeseries_t;
64 /*
65 * Time-series options specify generic parameters to be used when fetching
66 * time-series data from a data-store.
67 */
68 typedef struct {
69 sdb_time_t start;
70 sdb_time_t end;
71 } sdb_timeseries_opts_t;
73 /*
74 * sdb_timeseries_create:
75 * Allocate a time-series object, pre-populating the data_names information
76 * and allocating the data field.
77 *
78 * Returns:
79 * - a newly allocated time-series object on success
80 * - NULL else
81 */
82 sdb_timeseries_t *
83 sdb_timeseries_create(size_t data_names_len, const char * const *data_names,
84 size_t data_len);
86 /*
87 * sdb_timeseries_destroy:
88 * Destroy a time-series object, freeing all of its memory.
89 */
90 void
91 sdb_timeseries_destroy(sdb_timeseries_t *ts);
93 #ifdef __cplusplus
94 } /* extern "C" */
95 #endif
97 #endif /* ! SDB_CORE_TIMESERIES_H */
99 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */