rtkProgressCommands.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/

#ifndef rtkProgressCommands_h
#define rtkProgressCommands_h

#include <itkCommand.h>

namespace rtk
{

template <typename TCaller>
class ITK_TEMPLATE_EXPORT ProgressCommand : public itk::Command
{
public:
  typedef ProgressCommand         Self;
  typedef itk::Command            Superclass;
  typedef itk::SmartPointer<Self> Pointer;

  void
  Execute(itk::Object * caller, const itk::EventObject & event) override
  {
    Execute((const itk::Object *)caller, event);
  }

  void
  Execute(const itk::Object * caller, const itk::EventObject & event) override
  {
    const auto * cCaller = dynamic_cast<const TCaller *>(caller);
    if (cCaller)
    {
      if (itk::EndEvent().CheckEvent(&event))
      {
        End(cCaller);
        return;
      }
      if (itk::ProgressEvent().CheckEvent(&event))
      {
        Run(cCaller);
      }
    } // TODO fail when cast fails
  }


protected:
  virtual void
  Run(const TCaller * caller) = 0;

  virtual void
  End(const TCaller * itkNotUsed(caller))
  { /* Default implementation: do nothing */
  }
};

template <typename TCaller>
class ITK_TEMPLATE_EXPORT PercentageProgressCommand : public ProgressCommand<TCaller>
{
public:
  typedef PercentageProgressCommand Self;
  typedef ProgressCommand<TCaller>  Superclass;
  typedef itk::SmartPointer<Self>   Pointer;
  itkNewMacro(Self);

  int percentage = -1;

protected:
  void
  Run(const TCaller * caller) override
  {
    int newPercentage = (int)(caller->GetProgress() * 100.);
    if (newPercentage > percentage)
    {
      // TODO allow string personnalization?
      std::cout << "\r" << caller->GetNameOfClass() << " " << newPercentage << "% completed." << std::flush;
      percentage = newPercentage;
    }
  }

  void
  End(const TCaller * itkNotUsed(caller)) override
  {
    std::cout << std::endl; // new line when execution ends
  }
};

} // end namespace rtk

#endif