berryStatus.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 BERRYSTATUS_H_
#define BERRYSTATUS_H_

#include "berryIStatus.h"

#include <org_blueberry_core_runtime_Export.h>

namespace berry {

class org_blueberry_core_runtime_EXPORT Status : public virtual IStatus
{

public:

  struct SourceLocation {

    SourceLocation(const QString& fileName = QString(), const QString& methodName = QString(), int lineNumber = 0)
      : fileName(fileName), methodName(methodName), lineNumber(lineNumber)
    {}

    const QString fileName;
    const QString methodName;
    const int lineNumber;
  };

private:

  Severity severity;

  QString pluginId;

  int code;

  QString message;

  ctkException* exception;

  static const QList<IStatus::Pointer> theEmptyStatusArray;

  SourceLocation sourceLocation;

public:

  static const IStatus::Pointer OK_STATUS(const SourceLocation& sl);
  static const IStatus::Pointer CANCEL_STATUS(const SourceLocation& sl);

  Status(const Severity& severity, const QString& pluginId, int code, const QString& message,
         const SourceLocation& sl);

  Status(const Severity& severity, const QString& pluginId, int code, const QString& message,
         const ctkException& exc, const SourceLocation& sl);

  Status(const Severity& severity, const QString& pluginId, const QString& message,
         const SourceLocation& sl);

  Status(const Severity& severity, const QString& pluginId, const QString& message,
         const ctkException& exc, const SourceLocation& sl);

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  QList<IStatus::Pointer> GetChildren() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  int GetCode() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  const ctkException* GetException() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  QString GetMessage() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  QString GetPlugin() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  Severity GetSeverity() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  bool IsMultiStatus() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  bool IsOK() const override;

  /*
   * Implements the corresponding method on <code>IStatus</code>.
   */
  bool Matches(const Severities& severityMask) const override;

  QString GetFileName() const override;

  QString GetMethodName() const override;

  int GetLineNumber() const override;


protected:

  virtual void SetCode(int code);

  virtual void SetException(const ctkException& exception);

  virtual void SetMessage(const QString& message);

  virtual void SetPlugin(const QString& pluginId);

  virtual void SetSeverity(const Severity& severity);


public:

  QString ToString() const override;

};

}

#define BERRY_STATUS_LOC berry::Status::SourceLocation(__FILE__, __FUNCTION__, __LINE__)

#endif /* BERRYSTATUS_H_ */