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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* 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 otbWrapperParameter_h
#define otbWrapperParameter_h
#include "OTBApplicationEngineExport.h"
#include "otbMacro.h"
#include "otbWrapperTypes.h"
#include <itkObjectFactory.h>
#include <string>
namespace otb
{
namespace Wrapper
{
/** \class Parameter
* \brief This class represent a parameter for the wrapper framework
* This class is a high level class representing a parameter for the
* wrapper framework. It should be subclassed to represent different
* kinds of parameters
*
* \ingroup OTBApplicationEngine
*/
class OTBApplicationEngine_EXPORT Parameter : public itk::Object
{
public:
/** Standard class typedef */
typedef Parameter Self;
typedef itk::Object Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** RTTI support */
itkTypeMacro(Parameter, itk::Object);
/** Set/get the parameter name */
virtual void SetName(const std::string&);
virtual const char* GetName() const;
/** Set/get the parameter description */
virtual void SetDescription(const std::string&);
virtual const std::string& GetDescription() const;
/** Set/get the parameter key */
virtual void SetKey(const std::string&);
virtual const char* GetKey() const;
/** Set the parameter Active flag */
virtual void SetActive(bool flag);
bool GetActive(bool recurseParents = false) const;
/** Set the parameter Mandatory flag */
virtual void SetMandatory(bool flag);
virtual bool GetMandatory() const;
virtual void MandatoryOn();
virtual void MandatoryOff();
/** Set the parameter AutomaticValue flag (which is the opposite of UserValue)*/
virtual void SetAutomaticValue(bool flag);
/** Get the parameter AutomaticValue flag */
virtual bool GetAutomaticValue() const;
/** Toggle ON the parameter AutomaticValue flag */
void AutomaticValueOn();
/** Toggle OFF the parameter AutomaticValue flag */
void AutomaticValueOff();
/** Set the user access level */
virtual void SetUserLevel(const UserLevel level);
/** Get the user access level */
virtual UserLevel GetUserLevel() const;
/** Set the parameter io type*/
virtual void SetRole(const Role role);
/** Get the user access level */
virtual Role GetRole() const;
/** Reset to the the default value. Default implementation does
* nothing
*/
virtual void Reset();
virtual bool HasValue() const = 0;
virtual bool HasUserValue() const;
virtual void SetUserValue(bool isUserValue);
virtual void ClearValue();
/** Set/Get the root of the current parameter (direct parent) */
virtual void SetRoot(const Parameter::Pointer root);
virtual const Parameter::Pointer GetRoot() const;
/** Is the parameter a root or a child of another param */
virtual bool IsRoot() const;
/** Add a child of this parameter when the param is a Group or a
* choice
*/
virtual void AddChild(Parameter::Pointer child);
/** Get the children pointer list : not const cause we need to
* alterate the m_Active status and the m_IsCheckbox
*/
virtual std::vector<Parameter::Pointer> GetChildrenList();
/** Get the dynamic type as declared in WrapperTypes.h */
virtual ParameterType GetType() const = 0;
/** Error raising function to indicate a type conversion error */
[[noreturn]] void TypeError(const std::string& target_type) const;
/** Parameter conversion functions. They are used by WrapperApplication
* to provide functions like SetParameterInt, GetParameterString, etc.
*/
virtual int ToInt() const;
virtual float ToFloat() const;
virtual double ToDouble() const;
virtual std::string ToString() const;
virtual std::vector<std::string> ToStringList() const;
virtual void FromInt(int);
virtual void FromFloat(float);
virtual void FromDouble(double);
virtual void FromString(const std::string&);
virtual void FromStringList(const std::vector<std::string>&);
protected:
/** Constructor */
Parameter();
/** Name of the parameter */
std::string m_Name;
/** Description of the parameter */
std::string m_Description;
/** Key of the parameter */
std::string m_Key;
/** True if the parameter is mandatory */
bool m_Mandatory;
/** True if activated (a mandatory parameter is always active) */
bool m_Active;
/** True if the value is set in user mode (otherwise, it is an automatic value)*/
bool m_UserValue;
UserLevel m_UserLevel;
/** Default iotype mode */
Role m_Role;
/** List of parents Parameters */
itk::WeakPointer<Parameter> m_Root;
/** List of children parameters */
std::vector<Parameter::Pointer> m_ChildrenList;
private:
Parameter(const Parameter&) = delete;
void operator=(const Parameter&) = delete;
}; // End class Parameter
} // End namespace Wrapper
} // End namespace otb
#endif
|
