otbFilterWatcherBase.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 otbFilterWatcherBase_h
#define otbFilterWatcherBase_h
 
#include <string>
 
#include "otbStopwatch.h"
#include "itkCommand.h"
#include "itkProcessObject.h"
 
#include "OTBCommonExport.h"
 
namespace otb
 
{
class OTBCommon_EXPORT FilterWatcherBase
{
public:
  FilterWatcherBase(itk::ProcessObject* process, const char* comment = "");
 
  FilterWatcherBase();
 
  FilterWatcherBase(const FilterWatcherBase&);
 
  void operator=(const FilterWatcherBase&);
 
  virtual ~FilterWatcherBase();
 
  const char* GetNameOfClass()
  {
    return (m_Process.GetPointer() ? m_Process->GetNameOfClass() : "None");
  }
 
  itk::ProcessObject* GetProcess()
  {
    return m_Process.GetPointer();
  }
 
  std::string GetComment()
  {
    return m_Comment;
  }
 
  otb::Stopwatch& GetStopwatch()
  {
    return m_Stopwatch;
  }
 
protected:
  virtual void ShowProgressCallback()
  {
    this->ShowProgress();
  }
 
  virtual void StartFilterCallback()
  {
    if (!m_Started)
    {
      this->StartFilter();
      m_Started = true;
    }
  }
 
  virtual void EndFilterCallback()
  {
    if (!m_Ended)
    {
      this->EndFilter();
      m_Ended = true;
    }
  }
 
  virtual void ShowProgress() = 0;
 
  virtual void StartFilter() = 0;
 
  virtual void EndFilter() = 0;
 
  otb::Stopwatch m_Stopwatch;
 
  std::string m_Comment;
 
  itk::ProcessObject::Pointer m_Process;
 
  typedef itk::SimpleMemberCommand<FilterWatcherBase> CommandType;
 
  CommandType::Pointer m_StartFilterCommand;
 
  CommandType::Pointer m_EndFilterCommand;
 
  CommandType::Pointer m_ProgressFilterCommand;
 
  unsigned long m_StartTag;
 
  unsigned long m_EndTag;
 
  unsigned long m_ProgressTag;
 
  bool m_Started;
 
  bool m_Ended;
 
private:
};
 
} // end namespace otb
 
#endif