berryIJobChangeListener.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 BERRYIJOBCHANGELISTENER_H_
#define BERRYIJOBCHANGELISTENER_H_

#include "berryIJobChangeEvent.h"

namespace berry
{

struct BERRY_JOBS IJobChangeListener
{

  struct BERRY_JOBS Events
  {

    typedef Message1<const IJobChangeEvent::ConstPointer&> JobChangeEventType;

    enum Type
    {
      NONE = 0x00000000,
      ABOUT_TO_RUN = 0x00000001,
      AWAKE = 0x00000002,
      DONE = 0x00000004,
      RUNNING = 0x00000008,
      SCHEDULED = 0x00000010,
      SLEEPING = 0x00000020,

      ALL = 0xffffffff
    };

    Q_DECLARE_FLAGS(Types, Type)

    JobChangeEventType jobAboutToRun;
    JobChangeEventType jobAwake;
    JobChangeEventType jobDone;
    JobChangeEventType jobRunning;
    JobChangeEventType jobScheduled;
    JobChangeEventType jobSleeping;

    void AddListener(IJobChangeListener* listener);
    void RemoveListener(IJobChangeListener* listener);

    void SetExceptionHandler(const AbstractExceptionHandler& handler);

    typedef MessageDelegate1<IJobChangeListener, const IJobChangeEvent::ConstPointer&>
        Delegate;
  };

  virtual Events::Types GetEventTypes() = 0;

  virtual void AboutToRun(const IJobChangeEvent::ConstPointer& /*event*/)
  {
  }

  virtual void Awake(const IJobChangeEvent::ConstPointer& /*event*/)
  {
  }

  virtual void Done(const IJobChangeEvent::ConstPointer& /*event*/)
  {
  }

  virtual void Running(const IJobChangeEvent::ConstPointer& /*event*/)
  {
  }

  virtual void Scheduled(const IJobChangeEvent::ConstPointer& /*event*/)
  {
  }

  virtual void Sleeping(const IJobChangeEvent::ConstPointer& /*event*/)
  {
  }

};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(berry::IJobChangeListener::Events::Types)

#endif /* BERRYIJOBCHANGELISTENER_H_ */