UpdatePolicyManager.h

Go to the documentation of this file.

// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.


#ifndef QC_CHECKER_POLICYMANAGER_H
#define QC_CHECKER_POLICYMANAGER_H

#include <string>
#include <map>
#include <vector>
#include <functional>
#include <iosfwd>

namespace o2::quality_control::checker
{

using UpdatePolicyFunctionType = std::function<bool()>;
typedef uint32_t RevisionType;

struct UpdatePolicy {
  std::string actorName;
  UpdatePolicyFunctionType isReady;
  std::vector<std::string> inputObjects;
  bool allInputObjects;
  // TODO this line makes me think that lambdas are not enough because we actually need to store a state...
  bool policyHelperFlag; // the purpose might change depending on policy,
  RevisionType revision = 0;

  friend std::ostream& operator<<(std::ostream& out, const UpdatePolicy& updatePolicy); // output
};

class UpdatePolicyManager
{
 public:
  void updateGlobalRevision();
  void updateActorRevision(const std::string& actorName, RevisionType revision);
  void updateActorRevision(std::string actorName);
  void updateObjectRevision(std::string objectName, RevisionType revision);
  void updateObjectRevision(std::string objectName);
  void addPolicy(std::string actorName, std::string policyType, std::vector<std::string> objectNames, bool allObjects, bool policyHelper);
  bool isReady(const std::string& actorName);

 private:
  std::map<std::string /* Actor name */, UpdatePolicy> mPoliciesByActor;
  RevisionType mGlobalRevision = 1;
  std::map<std::string /* Object name */, RevisionType> mObjectsRevision;
};

} // namespace o2::quality_control::checker

#endif // QC_CHECKER_POLICYMANAGER_H