otbWrapperDocExampleStructure.h

Go to the documentation of this file.

/*
 * 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 otbWrapperDocExampleStructure_h
#define otbWrapperDocExampleStructure_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
 
#include <string>
#include <vector>
#include "otbConfigure.h"
#include "itkFixedArray.h"
#include "OTBApplicationEngineExport.h"
 
namespace otb
{
namespace Wrapper
{
 
class OTBApplicationEngine_EXPORT DocExampleStructure : public itk::Object
{
public:
  typedef DocExampleStructure           Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(DocExampleStructure, itk::Object);
 
  typedef std::pair<std::string, std::string> ParameterType;
  typedef std::vector<ParameterType>        ParametersVectorType;
  typedef std::vector<ParametersVectorType> ParametersVectorOfVectorType;
 
  itkGetMacro(NbOfExamples, unsigned int);
 
  void AddParameter(const std::string &key, const std::string &name, unsigned int exId = 0);
 
  ParametersVectorOfVectorType GetParameterList();
 
  unsigned int GetNumberOfParameters(unsigned int exId = 0);
 
  std::string GetParameterKey(unsigned int i, unsigned int exId = 0);
 
  std::string GetParameterValue(unsigned int i, unsigned int exId = 0);
 
  void SetApplicationName(const std::string &name);
 
  std::string GetApplicationName();
 
  std::vector<std::string> GetExampleCommentList();
 
  std::string GetExampleComment(unsigned int i);
 
  void SetExampleComment(const std::string& comm, unsigned int i);
 
  unsigned int AddExample(const std::string& comm = "");
 
  std::string GenerateCLExample(unsigned int exId);
 
  std::string GenerateCLExample();
 
  std::string GenerateHtmlExample(unsigned int exId);
 
  std::string GenerateHtmlExample();
 
protected:
  DocExampleStructure();
 
  ~DocExampleStructure() override;
 
private:
  DocExampleStructure(const DocExampleStructure&) = delete;
  void operator=(const DocExampleStructure&) = delete;
 
  ParametersVectorOfVectorType m_ParameterList;
 
  std::string m_ApplicationName;
 
  std::vector<std::string> m_ExampleCommentList;
 
  unsigned int m_NbOfExamples;
 
}; // End class Parameter
 
} // End namespace Wrapper
} // End namespace otb
 
#endif