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
|
/*=========================================================================
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 otbWrapperChoiceParameter_h
#define otbWrapperChoiceParameter_h
#include "otbWrapperParameterGroup.h"
namespace otb
{
namespace Wrapper
{
/** \class ChoiceParameter
* \brief This class represent a multiple choice parameter for the wrapper framework
*
* Represents an enumerated parameter.
* The different values of the enumeration can be associated with a parameter
*
* \ingroup OTBApplicationEngine
*/
class OTBApplicationEngine_EXPORT ChoiceParameter
: public Parameter
{
public:
/** Standard class typedef */
typedef ChoiceParameter Self;
typedef Parameter Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Defining ::New() static method */
itkNewMacro(Self);
/** RTTI support */
itkTypeMacro(ChoiceParameter, Parameter);
/** Add a value to the choice */
void AddChoice( std::string choicekey, std::string choiceName );
/** Get the key of a specific choice value */
std::string GetChoiceKey( int i );
/** Get the list of the different choice keys */
std::vector<std::string> GetChoiceKeys();
/** Get the long name of a specific choice value */
std::string GetChoiceName( int i );
/** Get the list of the different choice keys */
std::vector<std::string> GetChoiceNames();
/** Get the ParameterGroup associated to a choice value */
ParameterGroup::Pointer GetChoiceParameterGroupByIndex( int i );
/** Get the ParameterGroup associated to a choice value */
ParameterGroup::Pointer GetChoiceParameterGroupByKey( std::string choiceKey );
/** Get all parameters that are child of this choice parameter */
std::vector<std::string> GetParametersKeys();
/** Get the number of available choice */
unsigned int GetNbChoices( void );
/** Set choice value */
virtual void SetValue(unsigned int v);
/** Set choice value by its key */
virtual void SetValue(std::string choiceKey);
/** Return any value */
virtual unsigned int GetValue();
bool HasValue() const ITK_OVERRIDE
{
// a choice parameter always has a value
return true;
}
void ClearValue() ITK_OVERRIDE
{
// nothing to do : a choice parameter always has a value
}
protected:
/** Constructor */
ChoiceParameter();
/** Destructor */
~ChoiceParameter() ITK_OVERRIDE;
struct Choice
{
Choice() {}
std::string m_Key;
std::string m_Name;
ParameterGroup::Pointer m_AssociatedParameter;
};
typedef std::vector<Choice> ChoiceList;
ChoiceList m_ChoiceList;
unsigned int m_CurrentChoice;
private:
ChoiceParameter(const ChoiceParameter &); //purposely not implemented
void operator =(const ChoiceParameter&); //purposely not implemented
}; // End class Parameter
} // End namespace Wrapper
} // End namespace otb
#endif
|
