view OrthancFramework/Sources/MultiThreading/IRunnableBySteps.h @ 4985:c767035fff77

cppcheck
author Alain Mazy <am@osimis.io>
date Mon, 25 Apr 2022 19:17:28 +0200
parents 43e613a7756b
children 0ea402b4d901
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-2022 Osimis S.A., Belgium
 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "../IDynamicObject.h"

namespace Orthanc
{
  class IRunnableBySteps : public IDynamicObject
  {
  public:
    virtual ~IRunnableBySteps()
    {
    }

    // Must return "true" if the runnable wishes to continue. Must
    // return "false" if the runnable has not finished its job.
    virtual bool Step() = 0;

    static void RunUntilDone(IRunnableBySteps& runnable)
    {
      while (runnable.Step());
    }
  };
}