otbWrapperApplicationHtmlDocGenerator.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.


     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 __otbWrapperApplicationHtmlDocGenerator_h
#define __otbWrapperApplicationHtmlDocGenerator_h

#include "otbWrapperApplication.h"

namespace otb
{
namespace Wrapper
{
class ITK_EXPORT ApplicationHtmlDocGenerator
{
public:
  typedef ApplicationHtmlDocGenerator   Self;

  ApplicationHtmlDocGenerator();

  virtual ~ApplicationHtmlDocGenerator();

  static void GenerateDoc( const Application::Pointer app, const std::string & filename, const bool showKey = false );
  static void GenerateDoc( const Application::Pointer app, std::string & val, const bool showKey = false);

protected:

  static void GetDocParameters( const Application::Pointer app, std::string & val, const bool showKey = false );

  static void GetDocParameterGroup( const Application::Pointer app, std::string & val, const std::string & key, const bool showKey = false );

  static void GetDocParameterChoice( const Application::Pointer app, std::string & val, const std::string & key, const bool showKey = false );


private:
  ApplicationHtmlDocGenerator(const ApplicationHtmlDocGenerator &); //purposely not implemented
  void operator =(const ApplicationHtmlDocGenerator&); //purposely not implemented

}; // End class InputImage Parameter

} // End namespace Wrapper
} // End namespace otb

#endif