berryJob.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef _BERRY_JOB_H
#define _BERRY_JOB_H
 
#include <Poco/Thread.h>
 
#include <org_blueberry_core_jobs_Export.h>
#include "berryJobExceptions.h"
#include "internal/berryInternalJob.h"
 
#include <berryObject.h>
 
#include <string>
 
namespace berry
{
 
struct IJobManager;
 
class BERRY_JOBS Job: public InternalJob
{
 
public:
 
   berryObjectMacro(Job);
 
   static const IStatus::Pointer ASYNC_FINISH ;
 
  /* Job priorities */
  static const int INTERACTIVE = 10;
  static const int SHORT = 20;
  static const int LONG = 30;
  static const int BUILD = 40;
 
  static const int DECORATE = 50;
  static const int NONE = 0;
  static const int SLEEPING = 0x01;
  static const int WAITING = 0x02;
  static const int RUNNING = 0x04;
 
  static const IJobManager* GetJobManager();
 
  Job(const QString& name);
 
  void AddJobChangeListener(IJobChangeListener* listener);
 
  bool BelongsTo(Object::Pointer family) override;
 
  bool Cancel();
 
  void Done(IStatus::Pointer result);
 
  QString GetName() const;
 
  int GetPriority() const;
 
   IStatus::Pointer GetResult() const ;
 
  ISchedulingRule::Pointer GetRule() const;
 
  int GetState() const;
 
  Poco::Thread* GetThread() const;
 
  bool IsBlocking();
 
  bool IsSystem() const;
 
  bool IsUser() const;
 
  void RemoveJobChangeListener(IJobChangeListener* listener);
 
 
  void Schedule();
 
  void Schedule(Poco::Timestamp::TimeDiff delay);
 
  void SetName(const QString& name);
 
  void SetPriority(int priority);
 
  void SetProgressGroup(IProgressMonitor::Pointer group, int ticks);
 
  void SetRule(ISchedulingRule::Pointer rule);
 
  void SetSystem(bool value);
 
  void SetUser(bool value);
 
  void SetThread(Poco::Thread* thread);
 
  virtual bool ShouldRun();
 
  bool ShouldSchedule() override;
 
  bool Sleep();
 
  void WakeUp();
 
  void WakeUp(long delay);
 
 
protected:
 
  void Canceling() override;
 
  IStatus::Pointer Run(IProgressMonitor::Pointer myProgressMonitor) override = 0;
 
};
 
}
#endif /* BERRY_JOB_H */