otbStandardOneLineFilterWatcher.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 otbStandardOneLineFilterWatcher_h
#define otbStandardOneLineFilterWatcher_h
 
#include <iosfwd>
#include <memory>
 
#include "otbFilterWatcherBase.h"
#include "otbStandardOutputPrintCallback.h"
 
namespace otb
{
 
template <class PrintCallbackType = StandardOutputPrintCallback>
class StandardOneLineFilterWatcher : public FilterWatcherBase
{
public:
  StandardOneLineFilterWatcher(itk::ProcessObject* process, const char* comment = "");
 
  StandardOneLineFilterWatcher(itk::ProcessObject* process, const std::string& comment = "");
 
  StandardOneLineFilterWatcher();
 
  ~StandardOneLineFilterWatcher() override = default;
 
  void SetStars(int count)
  {
    m_StarsCount = count;
  }
  const int& GetStars() const
  {
    return m_StarsCount;
  }
 
  void SetCallback(PrintCallbackType* callback)
  {
    m_Callback = callback;
  }
 
protected:
  void ShowProgress() override;
 
  void StartFilter() override;
 
  void EndFilter() override;
 
private:
  int m_StarsCount;
 
  int m_CurrentNbStars;
 
  std::string m_Buffer;
 
  PrintCallbackType* m_Callback;
 
  std::shared_ptr<PrintCallbackType> m_DefaultCallback;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStandardOneLineFilterWatcher.hxx"
#endif
 
#endif