abstract_printer.h

// 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_ABSTRACT_PRINTER_H
#define HEDGEHOG_ABSTRACT_PRINTER_H
#include <set>
#include "../../tools/logger.h"
namespace hh {


#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace core {
class CoreNode;
}
#endif //DOXYGEN_SHOULD_SKIP_THIS

class AbstractPrinter {
 private:
  std::set<core::CoreNode const *> uniqueNodes_ = {}; 
 public:
  AbstractPrinter() = default;

  virtual ~AbstractPrinter() = default;

  virtual void printGraphHeader(core::CoreNode const *node) = 0;

  virtual void printGraphFooter(core::CoreNode const *node) = 0;

  virtual void printNodeInformation(core::CoreNode *node) = 0;

  virtual void printEdge(core::CoreNode const *from,
                         core::CoreNode const *to,
                         std::string_view const &edgeType,
                         size_t const &queueSize,
                         size_t const &maxQueueSize,
                         bool isMemoryManaged) = 0;

  virtual void printClusterHeader(core::CoreNode const *clusterNode) = 0;

  virtual void printClusterFooter() = 0;

  virtual void printClusterEdge(core::CoreNode const *clusterNode) = 0;

  virtual void printExecutionPipelineHeader(core::CoreNode *epNode, core::CoreNode *switchNode) = 0;

  virtual void printExecutionPipelineFooter() = 0;

  virtual void printEdgeSwitchGraphs(core::CoreNode *to,
                                     std::string const &idSwitch,
                                     std::string_view const &edgeType,
                                     size_t const &queueSize,
                                     size_t const &maxQueueSize,
                                     bool isMemoryManaged) = 0;

  bool hasNotBeenVisited(core::CoreNode const *node) {
    return uniqueNodes_.insert(node).second;
  }
};
}
#endif //HEDGEHOG_ABSTRACT_PRINTER_H