otbWriterWatcherBase.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * Copyright (C) 2005-2022 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 otbWriterWatcherBase_h
#define otbWriterWatcherBase_h
 
#include <string>
 
#include "itkCommand.h"
#include "itkProcessObject.h"
#include "otbStopwatch.h"
 
#include "OTBCommonExport.h"
 
namespace otb
{
 
class OTBCommon_EXPORT WriterWatcherBase
{
public:
  WriterWatcherBase(itk::ProcessObject* process, const char* comment = "");
 
  WriterWatcherBase(itk::ProcessObject* process, itk::ProcessObject* source, const char* comment = "");
 
  WriterWatcherBase();
 
  WriterWatcherBase(const WriterWatcherBase&);
 
  void operator=(const WriterWatcherBase&);
 
  virtual ~WriterWatcherBase();
 
  const char* GetNameOfClass()
  {
    return (m_Process.GetPointer() ? m_Process->GetNameOfClass() : "None");
  }
 
  itk::ProcessObject* GetProcess()
  {
    return m_Process.GetPointer();
  }
 
  std::string GetComment() const
  {
    return m_Comment;
  }
 
  otb::Stopwatch& GetStopwatch()
  {
    return m_Stopwatch;
  }
 
protected:
  virtual void ShowWriterProgress() = 0;
 
  virtual void StartWriter() = 0;
 
  virtual void EndWriter() = 0;
 
  virtual void ShowFilterProgress() = 0;
 
  virtual void StartFilter() = 0;
 
  virtual void EndFilter() = 0;
 
  otb::Stopwatch m_Stopwatch;
 
  std::string m_Comment;
 
  itk::ProcessObject::Pointer m_Process;
 
  itk::ProcessObject::Pointer m_SourceProcess;
 
  typedef itk::SimpleMemberCommand<WriterWatcherBase> CommandType;
 
  CommandType::Pointer m_StartWriterCommand;
 
  CommandType::Pointer m_EndWriterCommand;
 
  CommandType::Pointer m_ProgressWriterCommand;
 
  CommandType::Pointer m_StartFilterCommand;
 
  CommandType::Pointer m_EndFilterCommand;
 
  CommandType::Pointer m_ProgressFilterCommand;
 
  unsigned long m_StartWriterTag;
 
  unsigned long m_EndWriterTag;
 
  unsigned long m_ProgressWriterTag;
 
  unsigned long m_StartFilterTag;
 
  unsigned long m_EndFilterTag;
 
  unsigned long m_ProgressFilterTag;
 
private:
};
 
} // end namespace otb
 
#endif