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
|
/*=========================================================================
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 otbWrapperRAMParameter_h
#define otbWrapperRAMParameter_h
#include "otbWrapperNumericalParameter.h"
namespace otb
{
namespace Wrapper
{
/** \class RAMParameter
* \brief This class represent a RAM parameter for the wrapper framework
*
* \ingroup OTBApplicationEngine
*/
class OTBApplicationEngine_EXPORT RAMParameter : public Parameter
{
public:
/** Standard class typedef */
typedef RAMParameter Self;
typedef Parameter Superclass;
typedef itk::SmartPointer<Self> Pointer;
typedef itk::SmartPointer<const Self> ConstPointer;
/** Defining ::New() static method */
itkNewMacro(Self);
/** RTTI support */
itkTypeMacro(RAMParameter, Parameter);
/** typedef */
typedef NumericalParameter<unsigned int> UnsignedIntParameter;
typedef UnsignedIntParameter::ScalarType ScalarType;
bool HasValue() const ITK_OVERRIDE
{
return m_UnsignedIntParam->HasValue();
}
// Set/Get Value
otbSetObjectMemberMacro(UnsignedIntParam, Value , ScalarType);
otbSetObjectMemberMacro(UnsignedIntParam, Value , std::string);
otbGetObjectMemberMacro(UnsignedIntParam, Value , ScalarType);
// Set/Get extremums
otbSetObjectMemberMacro(UnsignedIntParam, DefaultValue, ScalarType);
otbGetObjectMemberMacro(UnsignedIntParam, DefaultValue, ScalarType);
otbSetObjectMemberMacro(UnsignedIntParam, MinimumValue, ScalarType);
otbGetObjectMemberMacro(UnsignedIntParam, MinimumValue, ScalarType);
otbSetObjectMemberMacro(UnsignedIntParam, MaximumValue, ScalarType);
otbGetObjectMemberMacro(UnsignedIntParam, MaximumValue, ScalarType);
// Clear Value
void ClearValue() ITK_OVERRIDE
{
m_UnsignedIntParam->ClearValue();
}
// Reset
void Reset() ITK_OVERRIDE
{
m_UnsignedIntParam->Reset();
}
// Reimplement the SetActive method
void SetActive( const bool value ) ITK_OVERRIDE
{
Superclass::SetActive( value );
m_UnsignedIntParam->SetActive( value );
}
otbGetObjectMemberConstMacro(UnsignedIntParam, Active, bool);
protected:
/** Constructor */
RAMParameter()
{
this->SetName("RAM");
this->SetDescription("Set the maximum of available memory for the pipeline execution in mega bytes (optional, 256 by default).");
this->SetKey("ram");
// Initialize the unsigned int NumericalParam
m_UnsignedIntParam = UnsignedIntParameter::New();
// 0 RAM is not allowed, make the minimum to 1 by default
this->SetMinimumValue(1);
}
/** Destructor */
~RAMParameter() ITK_OVERRIDE
{}
private:
RAMParameter(const RAMParameter &); //purposely not implemented
void operator =(const RAMParameter&); //purposely not implemented
UnsignedIntParameter::Pointer m_UnsignedIntParam;
};
} // End namespace Wrapper
} // End namespace otb
#endif
|
