Various Doxygen fixes.
[dcpomatic.git] / src / lib / job.h
index 804755ef829413850e3b5ffc120ab3a19ab2c2a3..185273e2d590a1d604ed62632ea39d12ce66c9fe 100644 (file)
@@ -40,7 +40,7 @@ class Film;
 class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
 {
 public:
-       Job (boost::shared_ptr<const Film>);
+       Job (boost::shared_ptr<const Film> film);
        virtual ~Job ();
 
        /** @return user-readable name of this job */
@@ -50,7 +50,8 @@ public:
        virtual void run () = 0;
 
        void start ();
-       void pause ();
+       void pause_by_user ();
+       void pause_by_priority ();
        void resume ();
        void cancel ();
 
@@ -60,7 +61,8 @@ public:
        bool finished_ok () const;
        bool finished_in_error () const;
        bool finished_cancelled () const;
-       bool paused () const;
+       bool paused_by_user () const;
+       bool paused_by_priority () const;
 
        std::string error_summary () const;
        std::string error_details () const;
@@ -94,7 +96,8 @@ protected:
        enum State {
                NEW,            ///< the job hasn't been started yet
                RUNNING,        ///< the job is running
-               PAUSED,         ///< the job has been paused
+               PAUSED_BY_USER, ///< the job has been paused
+               PAUSED_BY_PRIORITY, ///< the job has been paused
                FINISHED_OK,    ///< the job has finished successfully
                FINISHED_ERROR, ///< the job has finished in error
                FINISHED_CANCELLED ///< the job was cancelled
@@ -103,6 +106,7 @@ protected:
        void set_state (State);
        void set_error (std::string s, std::string d);
        int elapsed_sub_time () const;
+       void check_for_interruption_or_pause ();
 
        boost::shared_ptr<const Film> _film;