transform.h

Go to the documentation of this file.

#ifndef SENSESP_TRANSFORMS_TRANSFORM_H_
#define SENSESP_TRANSFORMS_TRANSFORM_H_
 
#include "sensesp.h"
 
#include <ArduinoJson.h>
#include <set>
 
#include "sensesp/system/observable.h"
#include "sensesp/system/saveable.h"
#include "sensesp/system/valueconsumer.h"
#include "sensesp/system/valueproducer.h"
 
namespace sensesp {
 
// TODO(mairas): Split into multiple files
 
// Transforms transform raw device readouts into useful sensor values.
 
class TransformBase : public FileSystemSaveable {
 public:
  TransformBase(const String& config_path);
 
  virtual ~TransformBase();
 
  // The transform registry's original purpose (supplying Signal K sources) is
  // now handled by SKEmitter::get_sources(); nothing in the framework consumes
  // get_transforms() anymore. get_sources() is not a drop-in replacement -- it
  // returns only the Signal K emitters, not the full transform set, for which
  // there is no equivalent accessor.
  [[deprecated("Deprecated and unused internally; no direct replacement")]]
  static const std::set<TransformBase*>& get_transforms() {
    return transforms_;
  }
 
  static void clear_registry();
 
 private:
  static std::set<TransformBase*> transforms_;
};
 
template <typename C, typename P>
class Transform : public TransformBase,
                  public ValueConsumer<C>,
                  public ValueProducer<P> {
 public:
  Transform(String config_path = "")
      : TransformBase(config_path), ValueConsumer<C>(), ValueProducer<P>() {}
 
  Transform<C, P>* connect_from(ValueProducer<P>* producer0,
                                ValueProducer<P>* producer1 = NULL,
                                ValueProducer<P>* producer2 = NULL,
                                ValueProducer<P>* producer3 = NULL,
                                ValueProducer<P>* producer4 = NULL) {
    this->ValueConsumer<C>::connect_from(producer0);
    if (producer1 != NULL) {
      this->ValueConsumer<C>::connect_from(producer1, 1);
    }
    if (producer2 != NULL) {
      this->ValueConsumer<C>::connect_from(producer2, 2);
    }
    if (producer3 != NULL) {
      this->ValueConsumer<C>::connect_from(producer3, 3);
    }
    if (producer4 != NULL) {
      this->ValueConsumer<C>::connect_from(producer4, 4);
    }
    return this;
  }
};
 
template <typename T>
class SymmetricTransform : public Transform<T, T> {
 public:
  SymmetricTransform(String config_path = "") : Transform<T, T>(config_path) {}
};
 
typedef SymmetricTransform<float> FloatTransform;
typedef SymmetricTransform<int> IntegerTransform;
typedef SymmetricTransform<bool> BooleanTransform;
typedef SymmetricTransform<String> StringTransform;
 
}  // namespace sensesp
 
#endif