2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief A parent class to represent long-running tasks which are run in their own thread.
24 #ifndef DCPOMATIC_JOB_H
25 #define DCPOMATIC_JOB_H
28 #include <boost/thread/mutex.hpp>
29 #include <boost/enable_shared_from_this.hpp>
30 #include <boost/signals2.hpp>
31 #include <boost/thread.hpp>
36 * @brief A parent class to represent long-running tasks which are run in their own thread.
38 class Job : public boost::enable_shared_from_this<Job>, public boost::noncopyable
41 Job (boost::shared_ptr<const Film>);
44 /** @return user-readable name of this job */
45 virtual std::string name () const = 0;
46 /** Run this job in the current thread. */
47 virtual void run () = 0;
55 bool running () const;
56 bool finished () const;
57 bool finished_ok () const;
58 bool finished_in_error () const;
59 bool finished_cancelled () const;
62 std::string error_summary () const;
63 std::string error_details () const;
65 int elapsed_time () const;
66 virtual std::string status () const;
68 void set_progress_unknown ();
69 void set_progress (float);
72 float overall_progress () const;
74 boost::signals2::signal<void()> Progress;
75 /** Emitted from the UI thread when the job is finished */
76 boost::signals2::signal<void()> Finished;
80 virtual int remaining_time () const;
82 /** Description of a job's state */
84 NEW, ///< the job hasn't been started yet
85 RUNNING, ///< the job is running
86 PAUSED, ///< the job has been paused
87 FINISHED_OK, ///< the job has finished successfully
88 FINISHED_ERROR, ///< the job has finished in error
89 FINISHED_CANCELLED ///< the job was cancelled
92 void set_state (State);
93 void set_error (std::string s, std::string d);
95 boost::shared_ptr<const Film> _film;
101 boost::thread* _thread;
103 /** mutex for _state and _error */
104 mutable boost::mutex _state_mutex;
105 /** current state of the job */
107 /** summary of an error that has occurred (when state == FINISHED_ERROR) */
108 std::string _error_summary;
109 std::string _error_details;
111 /** time that this job was started */
114 /** mutex for _stack and _progress_unknown */
115 mutable boost::mutex _progress_mutex;
118 Level (float a) : allocation (a), normalised (0) {}
124 std::list<Level> _stack;
126 /** true if this job's progress will always be unknown */
127 bool _progress_unknown;