receiver_abstraction.h

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 HEDGEHOG_RECEIVER_ABSTRACTION_H
#define HEDGEHOG_RECEIVER_ABSTRACTION_H
 
#include <memory>
#include <utility>
#include <ostream>
 
#include "sender_abstraction.h"
#include "../any_groupable_abstraction.h"
#include "../node/node_abstraction.h"
 
namespace hh {
namespace core {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace implementor {
template<class Input>
class ImplementorReceiver;
}
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
 
namespace abstraction {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template<class Output>
class SenderAbstraction;
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
template<class Input>
class ReceiverAbstraction {
 private:
  std::shared_ptr<implementor::ImplementorReceiver<Input>>
      concreteReceiver_ = nullptr; 
 
  std::shared_ptr<std::mutex> const
      slotMutex_ = nullptr; 
 
 public:
  explicit ReceiverAbstraction(
      std::shared_ptr<implementor::ImplementorReceiver<Input>> concreteReceiver,
      std::shared_ptr<std::mutex> slotMutex) :
      concreteReceiver_(std::move(concreteReceiver)),
      slotMutex_(std::move(slotMutex)) {
    concreteReceiver_->initialize(this);
  }
 
  virtual ~ReceiverAbstraction() = default;
 
  [[nodiscard]] std::set<ReceiverAbstraction *> const &receivers() const { return concreteReceiver_->receivers(); }
 
  [[nodiscard]] std::set<ReceiverAbstraction *> &receivers() { return concreteReceiver_->receivers(); }
 
  [[nodiscard]] std::set<SenderAbstraction<Input> *> const &connectedSenders() const {
    return concreteReceiver_->connectedSenders();
  }
 
  void receive(std::shared_ptr<Input> const inputData) {
    slotMutex_->lock();
    concreteReceiver_->receive(inputData);
    slotMutex_->unlock();
  }
 
  std::shared_ptr<Input> getInputData() { return concreteReceiver_->getInputData(); }
 
  [[nodiscard]] size_t numberElementsReceived() const { return concreteReceiver_->numberElementsReceived(); }
 
  [[nodiscard]] size_t maxNumberElementsReceived() const { return concreteReceiver_->maxNumberElementsReceived(); }
 
  [[nodiscard]] bool empty() const { return concreteReceiver_->empty(); }
 
  void addSender(SenderAbstraction<Input> *const sender) { concreteReceiver_->addSender(sender); }
 
  void removeSender(SenderAbstraction<Input> *const sender) { concreteReceiver_->removeSender(sender); }
 
  void printEdgeInformation(Printer *printer) {
    auto nodeReceiver = dynamic_cast<NodeAbstraction const *>(this);
    if (nodeReceiver == nullptr) {
      throw std::runtime_error("To print an edge, a receiver should be a NodeAbstraction.");
    }
 
    for (auto receiver : ReceiverAbstraction<Input>::receivers()) {
      for (SenderAbstraction<Input> *connectedSender : receiver->connectedSenders()) {
        for (auto &s : connectedSender->senders()) {
          auto nodeSender = dynamic_cast<NodeAbstraction const *>(s);
          if (nodeSender == nullptr) {
            throw std::runtime_error("To print an edge, a sender should be a NodeAbstraction.");
          }
          printer->printEdge(
              nodeSender, nodeReceiver,
              tool::typeToStr<Input>(),
              receiver->numberElementsReceived(), receiver->maxNumberElementsReceived());
        }
      }
    }
  }
 
 protected:
  void copyInnerStructure(ReceiverAbstraction<Input> *copyableCore) {
    this->concreteReceiver_ = copyableCore->concreteReceiver_;
  }
};
}
}
}
#endif //HEDGEHOG_RECEIVER_ABSTRACTION_H