/usr/include/OTB-6.4/otbWrapperDocExampleStructure.h is in libotb-dev 6.4.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | /*
* Copyright (C) 2005-2017 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 <iostream>
#include <vector>
#include "otbConfigure.h"
#include "itkFixedArray.h"
#include "OTBApplicationEngineExport.h"
namespace otb
{
namespace Wrapper
{
/** \class DocExampleStructure
* \brief This class is a structure that gathered the necessary
* element to generate an example (for CommandLine, python, Java
* ...).
* User has to set the application name, the binary path and a list of
* key/value couple.
*
* \ingroup OTBApplicationEngine
*/
class OTBApplicationEngine_EXPORT DocExampleStructure :
public itk::Object
{
public:
/** Standard class typedefs */
typedef DocExampleStructure Self;
typedef itk::Object Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Standards macros */
itkNewMacro(Self);
/** Runtime information */
itkTypeMacro(DocExampleStructure, itk::Object);
typedef std::pair<std::string, std::string> ParameterType;
typedef std::vector<ParameterType> ParametersVectorType;
typedef std::vector<ParametersVectorType> ParametersVectorOfVectorType;
/** Get the number of examples */
itkGetMacro(NbOfExamples, unsigned int);
/** Parameter list accessors. */
/** Parameter list accessors : adding key and name */
void AddParameter( const std::string key, const std::string name, unsigned int exId = 0);
/** Get the parameter list. */
ParametersVectorOfVectorType GetParameterList();
/** Get number of parameters */
unsigned int GetNumberOfParameters(unsigned int exId = 0);
/** Get a specific parameter couple key.*/
std::string GetParameterKey( unsigned int i, unsigned int exId = 0 );
/** Get a specific parameter couple value as string.*/
std::string GetParameterValue( unsigned int i, unsigned int exId=0 );
/** Set Application name. */
void SetApplicationName( const std::string name );
/** Get Application name. */
std::string GetApplicationName();
/** Get the example comment list */
std::vector<std::string> GetExampleCommentList();
/** Get one example comment */
std::string GetExampleComment( unsigned int i);
/** Set one example comment */
void SetExampleComment( const std::string & comm, unsigned int i);
/** Add an example using comment. Return the index of the new example.*/
unsigned int AddExample( const std::string & comm = "");
/** Generation of the documentation for CommandLine for one specific
* example. */
std::string GenerateCLExample( unsigned int exId );
/** Generation of the documentation for CommandLine. */
std::string GenerateCLExample();
/** Generation of the documentation for Qt for one specific
* example. */
std::string GenerateHtmlExample( unsigned int exId );
/** Generation of the documentation for Qt. */
std::string GenerateHtmlExample();
protected:
/** Constructor */
DocExampleStructure();
/** Destructor */
~DocExampleStructure() ITK_OVERRIDE;
private:
DocExampleStructure(const DocExampleStructure &); //purposely not implemented
void operator =(const DocExampleStructure&); //purposely not implemented
/** List of the application parameters. List of key/name/value couples. */
ParametersVectorOfVectorType m_ParameterList;
/** Application name */
std::string m_ApplicationName;
/** Example comments */
std::vector<std::string> m_ExampleCommentList;
/** Stores the number of example. */
unsigned int m_NbOfExamples;
}; // End class Parameter
} // End namespace Wrapper
} // End namespace otb
#endif
|