JobGraph.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_JOBGRAPH_H
#define MYRAMATH_JOBGRAPH_JOBGRAPH_H

#include <myramath/utility/detail/LIBPUBLIC.h>
#include <myramath/utility/eprintf.h>

#include <myramath/jobgraph/JobID.h>

#include <string>
#include <stdint.h>

namespace myra {

// Forward declarations.
class Job;
class JobGraphBase;
class JobGraph;

class LIBPUBLIC JobGraphBase
  {
  public:

    virtual JobGraphBase* clone() const = 0;

    virtual uint64_t n_work() const { return 0; }
    
    virtual std::string name() const { return "JobGraph"; }

    virtual void begins(JobIDs& output) const { throw eprintf("JobGraphBase::begins(JobIDs&) not implemented for %s", this->name().c_str()); }

    virtual void ends(JobIDs& output) const { throw eprintf("JobGraphBase::ends(JobIDs&) not implemented for %s", this->name().c_str()); }

    virtual Job* create(JobID j) { throw eprintf("JobGraphBase::create(JobID) not implemented for %s", this->name().c_str()); }

    virtual std::vector<Job*> create(); // TODO make pure virtual

    virtual uint64_t size() const { throw eprintf("JobGraphBase::size() not implemented for %s", this->name().c_str()); } // TODO remove

    virtual ~JobGraphBase();

  };

class LIBPUBLIC JobGraph
  {
  public:

    // -------- Structural routines (ctor,copy,etc) --------------

    JobGraph();

    /*explicit*/ JobGraph(const JobGraphBase& that);

    JobGraph(const JobGraph& that);

    void swap(JobGraph& that);

    JobGraph& operator =(JobGraph that);

   ~JobGraph();  

    // ------ Job presentation API for consumers (execute, traverse, graphviz, etc) --------

    uint64_t n_work() const;
    
    std::string name() const;

    void begins(JobIDs& output) const;

    void ends(JobIDs& output) const;

    Job* create(JobID j) const;

    std::vector<Job*> create() const;

    uint64_t size() const;

  private:

    // Underlying polymorphic instance, a JobGraphBase.
    JobGraphBase* base;

  };

} // namespace myra

#endif