view OrthancFramework/Sources/JobsEngine/JobStatus.h @ 4081:259c33759937 framework

integration mainline->framework
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 22 Jun 2020 19:04:45 +0200
parents d25f4c0fa160
children bf7b9edf6b81
line wrap: on
line source

/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2020 Osimis S.A., Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * In addition, as a special exception, the copyright holders of this
 * program give permission to link the code of its release with the
 * OpenSSL project's "OpenSSL" library (or with modified versions of it
 * that use the same license as the "OpenSSL" library), and distribute
 * the linked executables. You must obey the GNU General Public License
 * in all respects for all of the code used other than "OpenSSL". If you
 * modify file(s) with this exception, you may extend this exception to
 * your version of the file(s), but you are not obligated to do so. If
 * you do not wish to do so, delete this exception statement from your
 * version. If you delete this exception statement from all source files
 * in the program, then also delete it here.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "IJob.h"

namespace Orthanc
{
  class JobStatus
  {
  private:
    ErrorCode      errorCode_;
    float          progress_;
    std::string    jobType_;
    Json::Value    publicContent_;
    Json::Value    serialized_;
    bool           hasSerialized_;
    std::string    details_;

  public:
    JobStatus();

    JobStatus(ErrorCode code,
              const std::string& details,
              IJob& job);

    ErrorCode GetErrorCode() const
    {
      return errorCode_;
    }

    void SetErrorCode(ErrorCode error)
    {
      errorCode_ = error;
    }

    float GetProgress() const
    {
      return progress_;
    }

    const std::string& GetJobType() const
    {
      return jobType_;
    }

    const Json::Value& GetPublicContent() const
    {
      return publicContent_;
    }

    const Json::Value& GetSerialized() const;

    bool HasSerialized() const
    {
      return hasSerialized_;
    }

    const std::string& GetDetails() const
    {
      return details_;
    }
  };
}