ALPS Home Libraries License Support People ALPS Web Site

PrevUpHomeNext

Class Task

alps::scheduler::Task

Synopsis

// In header: <alps/scheduler/task.h>


class Task : public alps::scheduler::AbstractTask {
public:
  // construct/copy/destruct
  Task(const ProcessList &, const boost::filesystem::path &);
  Task(const ProcessList &, const Parameters &);
  ~Task();

  // public static functions
  static void print_copyright(std::ostream &);
  static Parameters parse_ext_task_file(std::string);

  // public member functions
  virtual void construct();
  virtual void 
  checkpoint(const boost::filesystem::path &, bool = ALPS_WRITE_ALL_XML) const;
  void checkpoint_hdf5(const boost::filesystem::path &) const;
  void checkpoint_xml(const boost::filesystem::path &, 
                      bool = ALPS_WRITE_ALL_XML) const;
  virtual void add_process(const Process &);
  virtual uint32_t cpus() const;
  virtual bool local();
  const alps::Parameters & get_parameters() const;
  virtual void start();
  virtual void run();
  virtual void dostep() = 0;
  void finish();
  bool finished() const;
  virtual bool finished(double &, double &) const;
  bool started() const;
  virtual void halt();
  virtual double work() const;
  virtual ResultType get_summary() const;
  virtual void load(hdf5::archive &);
  virtual void save(hdf5::archive &) const;

  // protected member functions
  virtual void write_xml_header(alps::oxstream &) const;
  virtual void write_xml_trailer(alps::oxstream &) const;
  virtual void 
  write_xml_body(alps::oxstream &, boost::filesystem::path const &, bool) const = 0;
  virtual void handle_tag(std::istream &, const XMLTag &);

  // private member functions
  void parse_task_file(bool = false);
};

Description

Task public construct/copy/destruct

  1. Task(const ProcessList &, const boost::filesystem::path &);
  2. Task(const ProcessList &, const Parameters &);
  3. ~Task();

Task public static functions

  1. static void print_copyright(std::ostream &);
  2. static Parameters parse_ext_task_file(std::string);

Task public member functions

  1. virtual void construct();
  2. virtual void 
    checkpoint(const boost::filesystem::path &, bool = ALPS_WRITE_ALL_XML) const;
  3. void checkpoint_hdf5(const boost::filesystem::path &) const;
  4. void checkpoint_xml(const boost::filesystem::path &, 
                        bool = ALPS_WRITE_ALL_XML) const;
  5. virtual void add_process(const Process &);
  6. virtual uint32_t cpus() const;
  7. virtual bool local();
  8. const alps::Parameters & get_parameters() const;
  9. virtual void start();
  10. virtual void run();
  11. virtual void dostep() = 0;
  12. void finish();
  13. bool finished() const;
  14. virtual bool finished(double &, double &) const;
  15. bool started() const;
  16. virtual void halt();
  17. virtual double work() const;
  18. virtual ResultType get_summary() const;
  19. virtual void load(hdf5::archive &);
  20. virtual void save(hdf5::archive &) const;

Task protected member functions

  1. virtual void write_xml_header(alps::oxstream &) const;
  2. virtual void write_xml_trailer(alps::oxstream &) const;
  3. virtual void 
    write_xml_body(alps::oxstream &, boost::filesystem::path const & fn, 
                   bool writeall) const = 0;
  4. virtual void handle_tag(std::istream &, const XMLTag &);

Task private member functions

  1. void parse_task_file(bool = false);
Copyright © 1994, 2002-2005 Matthias Troyer, Synge Todo

PrevUpHomeNext