graphviz.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_JOBGRAPH_GRAPHVIZ_H
#define MYRAMATH_JOBGRAPH_GRAPHVIZ_H

#include <myramath/MYRAMATH_EXPORT.h>

// Output is written into a std::ostream.
#include <iosfwd>
#include <string>

namespace myra {

class JobGraph;
class JobGraphBase;

// Can take the output and pipe it through dot to make images or vector art:
// $ dot -Tpng -v -O graph.dot
// $ dot -Tsvg -v -O graph.dot
// $ dot -Tpdf -v -O graph.dot
MYRAMATH_EXPORT void graphviz(const JobGraph& graph, std::ostream& out);
MYRAMATH_EXPORT void graphviz(const JobGraph& graph, std::string filename);

} // namespace myra

#endif