scheduler-frontend.hpp

Go to the documentation of this file.

/*
  SCHEDULER-FRONTEND.hpp  -  access point to the scheduler within the renderengine

  Copyright (C)         Lumiera.org
    2011,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef VAULT_GEAR_SCHEDULER_FRONTEND_H
#define VAULT_GEAR_SCHEDULER_FRONTEND_H



#include "lib/depend.hpp"
#include "lib/time/timevalue.hpp"
#include "vault/gear/job.h"


namespace vault{
namespace gear {
  
  using lib::time::Time;
  
  
  class SchedulerFrontend
    {
    public:
      static lib::Depend<SchedulerFrontend> instance;
      
      
      class JobTransaction
        {
          SchedulerFrontend* sched_;
          
          
          JobTransaction (SchedulerFrontend* s)
            : sched_(s)
            { }
          
          friend class SchedulerFrontend;
          
          // using default copy operations
          
          
        public:
          void
          commit()
            {
              UNIMPLEMENTED ("feed all the attached jobs and transactions to the scheduler");
            }
          
          JobTransaction&
          addJob (Time deadline, Job const& job)
            {
              UNIMPLEMENTED ("a mock implementation for adding a single job; change this later to talk to the real scheduler");
              return *this;
            }
          
          JobTransaction&
          addBackground (Job const& job)
            {
              UNIMPLEMENTED ("a mock implementation for adding a single background job; change this later to talk to the real scheduler");
              return *this;
            }
          
          JobTransaction&
          addFreewheeling (Job const& job)
            {
              UNIMPLEMENTED ("a mock implementation for adding a single job for immediate calculation; change this later to talk to the real scheduler");
              return *this;
            }
          
          JobTransaction&
          attach (JobTransaction const& prerequisites)
            {
              UNIMPLEMENTED ("a mock implementation for adding a tree of prerequisite jobs; change this later to talk to the real scheduler");
              return *this;
            }
          
          JobTransaction
          startPrerequisiteTx()
            {
              return JobTransaction(sched_);
            }
          
        };
      
      
      JobTransaction
      startJobTransaction()
        {
          return JobTransaction(this);
        }
      
      
       
      
    protected:
      void activateTracing();
      void disableTracing(); 
      
      friend class SchedulerDiagnostics;
      
    private:
      
    };

}} // namespace vault::gear
#endif /*VAULT_GEAR_SCHEDULER_FRONTEND_H*/