aboutsummaryrefslogtreecommitdiffstats
path: root/signal-composer-binding/signal.hpp
blob: aa974da9127d7fcee54fad5c88c81074fe7a65b3 (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
/*
 * 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"

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 hasBool;
	bool boolVal;
	bool hasNum;
	double numVal;
	bool hasStr;
	std::string strVal;
};

/// @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_;
	long long int timestamp_;
	struct signalValue value_;
	std::map<long long int, struct signalValue> history_; ///< history_ - Hold signal value history in map with <timestamp, value>
	double frequency_;
	std::string unit_;
	CtlActionT* onReceived_;
	json_object* getSignalsArgs_;

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, double frequency, CtlActionT* onReceived, json_object* getSignalsArgs);
	Signal(const std::string& id, std::vector<std::string>& depends, const std::string& unit, double frequency, CtlActionT* onReceived);

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

	const std::string id() const;
	json_object* toJSON() const;

	void set(long long int timestamp, struct signalValue& value);
	void update(Signal* sig);
	int onReceivedCB(json_object *queryJ);
	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() const;

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

struct signalCBT
{
	void (*setSignalValue)(const char* aName, uint64_t timestamp, struct signalValue value);
};