2020-08-24 20:57:44 +02:00
|
|
|
/** Limit hook.
|
|
|
|
*
|
2022-12-14 17:41:58 +01:00
|
|
|
* @author Steffen Vogel <post@steffenvogel.de>
|
2022-03-15 09:28:57 -04:00
|
|
|
* @copyright 2014-2022, Institute for Automation of Complex Power Systems, EONERC
|
2022-07-04 18:20:03 +02:00
|
|
|
* @license Apache 2.0
|
2020-08-24 20:57:44 +02:00
|
|
|
*********************************************************************************/
|
|
|
|
|
|
|
|
#include <bitset>
|
|
|
|
|
|
|
|
#include <cstring>
|
|
|
|
|
|
|
|
#include <villas/hook.hpp>
|
|
|
|
#include <villas/node/exceptions.hpp>
|
2021-08-10 10:12:48 -04:00
|
|
|
#include <villas/signal.hpp>
|
|
|
|
#include <villas/sample.hpp>
|
2020-08-24 20:57:44 +02:00
|
|
|
|
|
|
|
namespace villas {
|
|
|
|
namespace node {
|
|
|
|
|
2021-07-06 16:28:10 +02:00
|
|
|
class LimitValueHook : public MultiSignalHook {
|
2020-08-24 20:57:44 +02:00
|
|
|
|
|
|
|
protected:
|
|
|
|
unsigned offset;
|
|
|
|
|
|
|
|
float min, max;
|
|
|
|
|
|
|
|
public:
|
2021-08-10 10:12:48 -04:00
|
|
|
LimitValueHook(Path *p, Node *n, int fl, int prio, bool en = true) :
|
2021-07-06 16:28:10 +02:00
|
|
|
MultiSignalHook(p, n, fl, prio, en),
|
2020-09-11 14:57:05 +02:00
|
|
|
offset(0),
|
2021-07-06 16:28:10 +02:00
|
|
|
min(0),
|
|
|
|
max(0)
|
|
|
|
{ }
|
2020-08-24 20:57:44 +02:00
|
|
|
|
2021-02-16 14:15:14 +01:00
|
|
|
virtual void parse(json_t *json)
|
2020-08-24 20:57:44 +02:00
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
json_error_t err;
|
|
|
|
|
|
|
|
assert(state != State::STARTED);
|
|
|
|
|
2021-07-06 16:28:10 +02:00
|
|
|
MultiSignalHook::parse(json);
|
2020-08-24 20:57:44 +02:00
|
|
|
|
2021-07-06 16:28:10 +02:00
|
|
|
ret = json_unpack_ex(json, &err, 0, "{ s: f, s: f }",
|
2020-08-24 20:57:44 +02:00
|
|
|
"min", &min,
|
2022-01-10 17:52:59 +01:00
|
|
|
"max", &max
|
2020-08-24 20:57:44 +02:00
|
|
|
);
|
|
|
|
if (ret)
|
2021-02-16 14:15:14 +01:00
|
|
|
throw ConfigError(json, err, "node-config-hook-average");
|
2020-08-24 20:57:44 +02:00
|
|
|
|
|
|
|
state = State::PARSED;
|
|
|
|
}
|
|
|
|
|
2021-08-10 10:12:48 -04:00
|
|
|
virtual Hook::Reason process(struct Sample *smp)
|
2020-08-24 20:57:44 +02:00
|
|
|
{
|
|
|
|
assert(state == State::STARTED);
|
|
|
|
|
2021-07-06 16:28:10 +02:00
|
|
|
for (auto index : signalIndices) {
|
|
|
|
switch (sample_format(smp, index)) {
|
2020-08-24 20:57:44 +02:00
|
|
|
case SignalType::INTEGER:
|
2021-07-06 16:28:10 +02:00
|
|
|
if (smp->data[index].i > max)
|
|
|
|
smp->data[index].i = max;
|
2020-08-24 20:57:44 +02:00
|
|
|
|
2021-07-06 16:28:10 +02:00
|
|
|
if (smp->data[index].i < min)
|
|
|
|
smp->data[index].i = min;
|
2020-08-24 20:57:44 +02:00
|
|
|
break;
|
|
|
|
|
|
|
|
case SignalType::FLOAT:
|
2021-07-06 16:28:10 +02:00
|
|
|
if (smp->data[index].f > max)
|
|
|
|
smp->data[index].f = max;
|
2020-08-24 20:57:44 +02:00
|
|
|
|
2021-07-06 16:28:10 +02:00
|
|
|
if (smp->data[index].f < min)
|
|
|
|
smp->data[index].f = min;
|
2020-08-24 20:57:44 +02:00
|
|
|
break;
|
|
|
|
|
|
|
|
case SignalType::INVALID:
|
|
|
|
case SignalType::COMPLEX:
|
|
|
|
case SignalType::BOOLEAN:
|
|
|
|
return Hook::Reason::ERROR; /* not supported */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return Reason::OK;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Register hook */
|
2021-08-10 10:12:48 -04:00
|
|
|
static char n[] = "limit_value";
|
|
|
|
static char d[] = "Limit signal values";
|
2020-08-24 20:57:44 +02:00
|
|
|
static HookPlugin<LimitValueHook, n , d, (int) Hook::Flags::PATH | (int) Hook::Flags::NODE_READ | (int) Hook::Flags::NODE_WRITE> p;
|
|
|
|
|
|
|
|
} /* namespace node */
|
|
|
|
} /* namespace villas */
|