Bookkeeper.hpp

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify and create derivative works of the software or any portion of the software, and you may copy and distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.
// NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE.
// You are solely responsible for determining the appropriateness of using and distributing the software and you assume all risks associated with its use, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of operation. This software is not intended to be used in any situation where a failure could cause risk of injury or damage to property. The software developed by NIST employees is not subject to copyright protection within the United States.

#ifndef HTGS_BOOKKEEPER_HPP
#define HTGS_BOOKKEEPER_HPP

#include <htgs/api/ITask.hpp>
#include <htgs/api/VoidData.hpp>
#include <htgs/core/rules/AnyRuleManagerInOnly.hpp>
#include <htgs/core/rules/RuleManager.hpp>

namespace htgs {

template<class T>
class Bookkeeper : public ITask<T, VoidData> {
  static_assert(std::is_base_of<IData, T>::value, "T must derive from IData");

 public:

  Bookkeeper() {
    this->ruleManagers = new std::list<AnyRuleManagerInOnly<T> *>();
  }

  virtual ~Bookkeeper() override {
    for (AnyRuleManagerInOnly<T> *ruleManager : *ruleManagers) {
      delete ruleManager;
      ruleManager = nullptr;
    }
    delete ruleManagers;
    ruleManagers = nullptr;
  }

  void addRuleManager(AnyRuleManager *ruleManager) {
    AnyRuleManagerInOnly<T> *baseRuleMan = (AnyRuleManagerInOnly<T> *) ruleManager;

    HTGS_DEBUG_VERBOSE(this << "----" << this->getName() << " adding rule manager " << baseRuleMan->getName());

    ruleManagers->push_back(baseRuleMan);
    ruleManagerInfo = ruleManagerInfo + " " + baseRuleMan->getName();
  }

  template<class U>
  void addRuleManager(RuleManager<T, U> *ruleManager) {

    HTGS_DEBUG_VERBOSE(this << "----" << this->getName() << " adding rule manager " << ruleManager->getName());

    ruleManagers->push_back(ruleManager);

    ruleManagerInfo = ruleManagerInfo + " " + ruleManager->getName();
  }

  void executeTask(std::shared_ptr<T> data) override {

    for (AnyRuleManagerInOnly<T> *ruleManager : *ruleManagers) {
//      HTGS_DEBUG_VERBOSE(this->getName() << " executing " + ruleManager->getName());
      ruleManager->executeTask(data);
    }
  }

  std::string getName() override {
    return "Bookkeeper -- " + std::to_string(this->ruleManagers->size()) + " rule(s): " +
        this->ruleManagerInfo;
  }

  virtual std::string getDotLabelName() override {
    return "Bookkeeper";
  }

  void debug() override {
    HTGS_DEBUG(this->getName() << " Details:");
    for (AnyRuleManagerInOnly<T> *ruleManager : *ruleManagers) {
      HTGS_DEBUG("Executing rule manager: " << ruleManager->getName());
      ruleManager->debug();
    }

  }

  bool canTerminate(std::shared_ptr<AnyConnector> inputConnector) override {
    // check input connector first
    HTGS_ASSERT(inputConnector != nullptr, "A Bookkeeper does not appear to have any input, which results in this bookkeeper not doing anything");
    assert(inputConnector != nullptr);
    if (inputConnector->isInputTerminated())
      return true;

    // Loop through each rule, if they can terminate, then initiate termination for that rule
    // This is used to assist in terminating a cycle
    for (auto ruleManager : *ruleManagers)
    {
      ruleManager->checkRuleTermination();
    }

    return false;
  }

  void initialize() override {
    for (AnyRuleManagerInOnly<T> *ruleManager : *ruleManagers) {
      ruleManager->initialize(this->getPipelineId(), this->getNumPipelines(), this->getAddress());
    }
  }

  void shutdown() {

    HTGS_DEBUG("Shutting down " << this->getName());
    for (AnyRuleManagerInOnly<T> *ruleManager : *ruleManagers) {
      ruleManager->shutdown();
    }
  }

  Bookkeeper<T> *copy() { return new Bookkeeper<T>(); }

  std::string genDot(int flags, std::string idStr) {
    std::ostringstream oss;
    for (AnyRuleManagerInOnly<T> *ruleMan : *ruleManagers) {
//      std::ostringstream ruleManOss;
//      ruleManOss <<

      std::string ruleManStr = ruleMan->getConnector()->getDotId();
//      ruleManStr.erase(0, 1);
      if ((flags & DOTGEN_FLAG_SHOW_CONNECTORS) != 0 || (flags & DOTGEN_FLAG_SHOW_CONNECTOR_VERBOSE) != 0) {
        oss << idStr << " -> " << ruleManStr << "[label=\"" << ruleMan->getName(flags) << "\"];" << std::endl;
      }
    }
//    std::string inOutLabel = (((flags & DOTGEN_FLAG_SHOW_IN_OUT_TYPES) != 0) ? ("\\nin: " + this->inTypeName()) : "");

    oss << idStr << ";" << std::endl;  // + "[label=\"Bookkeeper" + inOutLabel + "\"];" << std::endl;

    return oss.str();
  }


    std::string genDotProducerEdgeToTask(std::map<std::shared_ptr<AnyConnector>, AnyITask *> &inputConnectorDotMap, int dotFlags) override
  {
    std::ostringstream oss;
    for (AnyRuleManagerInOnly<T> *ruleMan : *ruleManagers) {
      auto connectorPair = inputConnectorDotMap.find(ruleMan->getConnector());
      if (connectorPair != inputConnectorDotMap.end())
      {
        oss << this->getDotId() << " -> " << connectorPair->second->getConsumerDotIds() << "[label=\"" << ruleMan->getName(dotFlags) << "\"];" << std::endl;
      }
    }

    return oss.str();
  }


  std::string genDotProducerEdgeFromConnector(std::shared_ptr<AnyConnector> connector, int flags)
  {
    std::ostringstream oss;
    if (connector != nullptr)
    {
      for (AnyRuleManagerInOnly<T> *ruleMan : *ruleManagers) {
        if (connector == ruleMan->getConnector())
        {
          oss << this->getDotId() << " -> " << connector->getDotId() << "[label=\"" << ruleMan->getName(flags) << "\"];" << std::endl;
        }
    }
    }

    return oss.str();
  }

  std::list<AnyRuleManagerInOnly<T> *> *getRuleManagers() {
    return ruleManagers;
  }

//  std::string genDotProducerEdgeWithoutConnector(std::string consumerDotId, int flags) override
//  {
//    std::cerr << "GENERATING CUSTOM DOT FILE FOR BOOKKEEEPER" << std::endl;
//    std::ostringstream oss;
//
//    for (AnyRuleManagerInOnly<T> *ruleMan : *ruleManagers) {
//
//      oss << this->getDotId() << " -> " << consumerDotId << "[label=\"" << ruleMan->getName(flags) << "\"];" << std::endl;
//    }
//
//    return oss.str();
//  }


 private:
  std::list<AnyRuleManagerInOnly<T> *> *ruleManagers; 
  std::string ruleManagerInfo; 
};
}

#endif //HTGS_BOOKKEEPER_HPP