otbFilterWatcherBase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.

  Some parts of this code are derived from ITK. See ITKCopyright.txt
  for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbFilterWatcherBase_h
#define __otbFilterWatcherBase_h

#include "itkCommand.h"
#include "itkProcessObject.h"
#include "itkTimeProbe.h"

namespace otb
{

class /*ITK_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;
  }

  itk::TimeProbe& GetTimeProbe()
  {
    return m_TimeProbe;
  }

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;

  itk::TimeProbe m_TimeProbe;

  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