ObserverPipeline.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2022 Stéphane Caron
 
#pragma once
 
#include <memory>
#include <vector>
 
#include "vulp/observation/Observer.h"
#include "vulp/observation/Source.h"
 
namespace vulp::observation {
 
class ObserverPipeline {
  using ObserverPtrVector = std::vector<std::shared_ptr<observation::Observer>>;
  using SourcePtrVector = std::vector<std::shared_ptr<observation::Source>>;
  using Dictionary = palimpsest::Dictionary;
 
 public:
  using iterator = ObserverPtrVector::iterator;
 
  void reset(const Dictionary& config);
 
  /* Add a source at the beginning of the pipeline.
   *
   * \param source Source to append.
   *
   * \note Contrary to observers, the order in which sources are executed is
   * not guaranteed. If a source needs to run after another, consider splitting
   * it into one source and one observer.
   */
  void connect_source(std::shared_ptr<Source> source) {
    sources_.push_back(std::shared_ptr<Source>(source));
  }
 
  /* Append an observer at the end of the pipeline.
   *
   * \param observer Observer to append.
   */
  void append_observer(std::shared_ptr<Observer> observer) {
    observers_.push_back(std::shared_ptr<Observer>(observer));
  }
 
  SourcePtrVector& sources() { return sources_; }
 
  size_t nb_sources() { return sources_.size(); }
 
  ObserverPtrVector& observers() { return observers_; }
 
  size_t nb_observers() { return observers_.size(); }
 
  void run(Dictionary& observation);
 
 private:
  SourcePtrVector sources_;
 
  ObserverPtrVector observers_;
};
 
}  // namespace vulp::observation