SourceGrouping.h

Go to the documentation of this file.

#ifndef _SEFRAMEWORK_PIPELINE_SOURCEGROUPING_H
#define _SEFRAMEWORK_PIPELINE_SOURCEGROUPING_H

#include <list>
#include <memory>

#include "SEFramework/Pipeline/PipelineStage.h"
#include "SEFramework/Source/SourceGroupFactory.h"
#include "SEFramework/Source/SourceGroupInterface.h"
#include "SEFramework/Source/SourceInterface.h"

namespace SourceXtractor {

class SelectionCriteria {
public:
  virtual ~SelectionCriteria() = default;

  virtual bool mustBeProcessed(const SourceInterface& source) const = 0;
};

class SelectAllCriteria : public SelectionCriteria {
public:
  bool mustBeProcessed(const SourceInterface& ) const override {
    return true;
  }
};

class GroupingCriteria {
public:
  virtual ~GroupingCriteria() = default;

  virtual bool shouldGroup(const SourceInterface& first, const SourceInterface& second) const = 0;

  virtual std::set<PropertyId> requiredProperties() const { return {}; }
};

class SourceGrouping : public PipelineEmitter<SourceGroupInterface>, public PipelineReceiver<SourceInterface> {
public:

  virtual ~SourceGrouping() = default;

  SourceGrouping(std::shared_ptr<GroupingCriteria> grouping_criteria,
                 std::shared_ptr<SourceGroupFactory> group_factory,
                 unsigned int hard_limit);

  std::set<PropertyId> requiredProperties() const;

  void receiveSource(std::unique_ptr<SourceInterface> source) override;

  void receiveProcessSignal(const ProcessSourcesEvent& event) override;

private:
  std::shared_ptr<GroupingCriteria> m_grouping_criteria;
  std::shared_ptr<SourceGroupFactory> m_group_factory;
  std::list<std::unique_ptr<SourceGroupInterface>> m_source_groups;
  unsigned int m_hard_limit;

}; /* End of SourceGrouping class */


} /* namespace SourceXtractor */


#endif