summaryrefslogtreecommitdiffstats
path: root/signal-composer-binding/signal.hpp
blob: 0a12b168b346e8fde91befa007844f986178b20c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
 * Copyright (C) 2015, 2016 "IoT.bzh"
 * Author "Romain Forlot" <romain.forlot@iot.bzh>
 *
 * 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.
*/

#pragma once

#include <map>
#include <string>
#include <vector>
#include <ctl-config.h>

#include "observer-pattern.hpp"

#define NANO 1000000000

class Composer;

/// @brief Structure holding a possible value of a Signal
///  as it could be different type of value, we declare all
///  possibility.
///  Not very efficient or optimized, maybe use of Variant in
///  C++17 but this is a bit too new to uses it for now
struct signalValue {
	bool undefined;
	bool hasBool;
	bool boolVal;
	bool hasNum;
	double numVal;
	bool hasStr;
	std::string strVal;

	signalValue():
		undefined(true), hasBool(false), boolVal(false), hasNum(false), numVal(0), hasStr(false), strVal("") {};
	signalValue(bool b):
		undefined(false), hasBool(true), boolVal(b), hasNum(false), numVal(0), hasStr(false), strVal("") {};
	signalValue(int i):
		undefined(false), hasBool(false), boolVal(false), hasNum(true), numVal(i), hasStr(false), strVal("") {};
	signalValue(double d):
		undefined(false), hasBool(false), boolVal(false), hasNum(true), numVal(d), hasStr(false), strVal("") {};
	signalValue(const std::string& s):
		undefined(false), hasBool(false), boolVal(false), hasNum(false), numVal(0), hasStr(true), strVal(s) {};
};

extern "C" void searchNsetSignalValueHandle(const char* aName, uint64_t timestamp, struct signalValue value);
extern "C" void setSignalValueHandle(void* aSignal, uint64_t timestamp, struct signalValue value);

/// @brief Holds composer callbacks and obj to manipulate
struct signalCBT
{
	void (*searchNsetSignalValue)(const char* aName, uint64_t timestamp, struct signalValue value);
	void (*setSignalValue)(void* aSignal, uint64_t timestamp, struct signalValue value);
	void* aSignal;
	void* pluginCtx;
};


/// @brief Holds a signal (raw or virtual) definition. Value could be of
///  different types, so an intermediate structure is use to store them.
///  A signal could also be a subject or an observer at the same time, this
///  is the behavior retained to compose virtual signals based on raw signals.
///  And this is the way that is used to update and reacts to an underlaying
///  signal change.
class Signal: public Observable<Signal>, public Observer<Signal>
{
private:
	std::string id_;
	std::string event_;
	std::vector<std::string> dependsSigV_;
	uint64_t timestamp_;
	struct signalValue value_;
	std::map<uint64_t, struct signalValue> history_; ///< history_ - Hold signal value history in map with <timestamp, value>
	int retention_;
	double frequency_;
	std::string unit_;
	json_object* metadata_;
	CtlActionT* onReceived_;
	json_object* getSignalsArgs_;
	struct signalCBT signalCtx_;

public:
	bool subscribed_; ///< subscribed_ - boolean value telling if yes or no the signal has been subcribed to the low level binding.
	Signal();
	Signal(const std::string& id, const std::string& event, std::vector<std::string>& depends, const std::string& unit, json_object *metadata, int retention, double frequency, CtlActionT* onReceived, json_object* getSignalsArgs);
	~Signal();

	explicit operator bool() const;
	bool operator==(const Signal& other) const;
	bool operator!=(const Signal& other) const;
	bool operator==(const std::string& aName) const;
	bool operator!=(const std::string& aName) const;

	const std::string id() const;
	json_object* toJSON() const;
	struct signalCBT* get_context();
	json_object *getSignalsArgs();

	void set(uint64_t timestamp, struct signalValue& value);
	void update(Signal* sig);
	static int defaultOnReceivedCB(CtlSourceT* source, json_object* argsJ, json_object *queryJ);
	void defaultReceivedCB(json_object *eventJ);
	void onReceivedCB(json_object *eventJ);
	void attachToSourceSignals(Composer& composer);

	double average(int seconds = 0) const;
	double minimum(int seconds = 0) const;
	double maximum(int seconds = 0) const;
	struct signalValue last_value() const;
	uint64_t last_timestamp() const;

	int initialRecursionCheck();
	int recursionCheck(Signal* obs);
};