printer.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_PRINTER_H
#define HEDGEHOG_PRINTER_H
 
#include <set>
#include <memory>
#include <ostream>
 
namespace hh {
 
namespace core {
namespace abstraction {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
class NodeAbstraction;
class GraphNodeAbstraction;
class AnyGroupableAbstraction;
class ExecutionPipelineNodeAbstraction;
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
}
}
 
class Printer {
 private:
  std::unique_ptr<std::set<core::abstraction::NodeAbstraction const * >>
      uniqueNodes_ = nullptr; 
 
 public:
  Printer() : uniqueNodes_(std::make_unique<std::set<core::abstraction::NodeAbstraction const * >>()) {}
 
  virtual ~Printer() = default;
 
  virtual void printGraphHeader(core::abstraction::GraphNodeAbstraction const *graph) = 0;
 
  virtual void printGraphFooter(core::abstraction::GraphNodeAbstraction const *graph) = 0;
 
  virtual void printExecutionPipelineHeader(
      core::abstraction::ExecutionPipelineNodeAbstraction const *ep,
      core::abstraction::NodeAbstraction const *switchNode) = 0;
 
  virtual void printExecutionPipelineFooter() = 0;
 
  virtual void printNodeInformation(core::abstraction::NodeAbstraction const *node) = 0;
 
  virtual void printEdge(core::abstraction::NodeAbstraction const *from, core::abstraction::NodeAbstraction const *to,
                         std::string const &edgeType,
                         size_t const &queueSize, size_t const &maxQueueSize) = 0;
 
  virtual void printGroup(core::abstraction::NodeAbstraction *representative,
                          std::vector<core::abstraction::NodeAbstraction *> const &group) = 0;
 
  virtual void printSource(core::abstraction::NodeAbstraction const *source) = 0;
 
  virtual void printSink(core::abstraction::NodeAbstraction const *sink) = 0;
 
  bool registerNode(core::abstraction::NodeAbstraction const *nodeAbstraction) {
    return uniqueNodes_->insert(nodeAbstraction).second;
  }
};
 
}
#endif //HEDGEHOG_PRINTER_H