berryJob.h

Go to the documentation of this file.

/*===================================================================

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef _BERRY_JOB_H
#define _BERRY_JOB_H

#include <Poco/Thread.h>

#include <org_blueberry_core_jobs_Export.h>
// #include "berryISchedulingRule.h"
#include "berryJobExceptions.h"
#include "internal/berryInternalJob.h"

#include <berryObject.h>

#include <string>

namespace berry
{

struct IJobManager;

//TODO  struct Job: public InternalJob, public IAdaptable
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;

  //TODO QualifiedName GetPropertys

   IStatus::Pointer GetResult() const ;

  ISchedulingRule::Pointer GetRule() const;

  int GetState() const;

  Poco::Thread* GetThread() const;

  bool IsBlocking();

  bool IsSystem() const;

  bool IsUser() const;

  //TODO Error Join  Problem InterruptedException

  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);

  //TODO QualifiedName SetProperty

  void SetRule(ISchedulingRule::Pointer rule);

  void SetSystem(bool value);

  void SetUser(bool value);

  void SetThread(Poco::Thread* thread);

  virtual bool ShouldRun();

  virtual bool ShouldSchedule() override;

  bool Sleep();

  void WakeUp();

  void WakeUp(long delay);


protected:

  virtual void Canceling() override;

  virtual IStatus::Pointer Run(IProgressMonitor::Pointer myProgressMonitor) override = 0;

};

}
#endif /* BERRY_JOB_H */