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
|
/*
* Copyright (C) 2005-2020 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.
*/
/**
* otbMacro.h defines standard system-wide macros, constants, and other
* parameters. One of its most important functions is to define macros used
* to interface to instance variables in a standard fashion.
*/
#ifndef otbMacro_h
#define otbMacro_h
#include "itkMacro.h"
#include "itkObject.h"
#include "otbConfigure.h"
#include "otbLogger.h"
/**
* \namespace otb
* \brief The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
*
* There are several nested namespaces within this one.
*/
namespace otb
{
} // end namespace otb - this is here for documentation purposes
#define otbFileContext(x) << "file " __FILE__ ", line " << __LINE__ << ", " x
#define otbClassContext(x) << this->GetNameOfClass() << " (" << this << "): " x
// Beware that to log to CRITICAL level, level should be passed as "Error"
#define otbLogMacro(level, msg) \
{ \
std::ostringstream itkmsg; \
itkmsg msg << "\n"; \
otb::Logger::Instance()->level(itkmsg.str().c_str()); \
}
// Re-definition of old log macros to use the otbLogMacro
#define otbDebugMacro(x) otbLogMacro(Debug, otbFileContext(otbClassContext(x)))
#define otbMsgDebugMacro(x) otbLogMacro(Debug, otbFileContext(x))
#define otbGenericMsgDebugMacro(x) otbLogMacro(Debug, x)
#define otbMsgDevMacro(x) otbLogMacro(Debug, otbFileContext(x))
#define otbWarningMacro(x) otbLogMacro(Warning, otbFileContext(otbClassContext(x)))
#define otbGenericWarningMacro(x) otbLogMacro(Warning, otbFileContext(x))
#define otbGenericMsgTestingMAcro(x) otbLogMacro(Info, "[testing] " << x)
/** This macro is used to control condition. It use ONLY by the OTB developers
*
*/
#define otbControlConditionTestMacro(condition, message) \
{ \
if ((condition)) \
itkGenericExceptionMacro(<< message); \
}
/** Set built-in type. Creates member Set"name"() (e.g., SetVisibility()); */
#define otbSetObjectMemberMacro(object, name, type) \
virtual void Set##name(const type _arg) \
{ \
itkDebugMacro("setting member " #name " to " << _arg); \
this->m_##object->Set##name(_arg); \
this->Modified(); \
}
/** Get built-in type. Creates member Get"name"() (e.g., GetVisibility()); */
#define otbGetObjectMemberMacro(object, name, type) \
virtual type Get##name() \
{ \
itkDebugMacro("returning " << #name " of " << this->m_##object->Get##name()); \
return this->m_##object->Get##name(); \
}
/** Get built-in type. Creates member Get"name"() (e.g., GetVisibility());
* This is the "const" form of the itkGetMacro. It should be used unless
* the member can be changed through the "Get" access routine. */
#define otbGetObjectMemberConstMacro(object, name, type) \
virtual type Get##name() const \
{ \
itkDebugMacro("returning " << #name " of " << this->m_##object->Get##name()); \
return this->m_##object->Get##name(); \
}
/** Get built-in type. Creates member Get"name"() (e.g., GetVisibility());
* This is the "const" form of the itkGetMacro. It should be used unless
* the member can be changed through the "Get" access routine.
* This versions returns a const reference to the variable. */
#define otbGetObjectMemberConstReferenceMacro(object, name, type) \
virtual const type& Get##name() const \
{ \
itkDebugMacro("returning " << #name " of " << this->m_##object->Get##name()); \
return this->m_##object->Get##name(); \
}
/** Testing macro. This macro doesn't throw a exception if the called command
* generate a itk::ExceptionObject object. For alls others use cases, the macro
* generate a exception. */
#define otbTestingCheckValidCommand(command) \
{ \
try \
{ \
command; \
} \
catch (const std::exception&) \
{ \
throw; \
} \
catch (...) \
{ \
std::ostringstream message; \
message << "otb::ERROR Unknown error while running " << #command << " (catch(...) )"; \
::itk::ExceptionObject e_(__FILE__, __LINE__, message.str(), ITK_LOCATION); \
throw e_; \
} \
std::cout << " Checking valid command " << #command " ok." << std::endl; \
}
#define otbGenericExceptionMacro(T, x) \
{ \
std::ostringstream message; \
message << "otb::ERROR: " x; \
T e_(__FILE__, __LINE__, message.str(), ITK_LOCATION); \
throw e_; \
}
#define otbTestingCheckNotValidCommand(command) \
{ \
int result(1); \
try \
{ \
command; \
} \
catch (std::bad_alloc & err) \
{ \
throw err; \
} \
catch (itk::ExceptionObject&) \
{ \
std::cout << "Checking not valid Command " << #command " ok." << std::endl; \
result = 0; \
} \
catch (const std::exception& stde) \
{ \
throw stde; \
} \
catch (...) \
{ \
std::ostringstream message; \
message << "otb::ERROR Unknown error while running " << #command << " (catch(...) )"; \
::itk::ExceptionObject e_(__FILE__, __LINE__, message.str(), ITK_LOCATION); \
throw e_; \
} \
if (result == 1) \
{ \
std::ostringstream message; \
message << "otb::ERROR: " << #command << " should be throwing an exception."; \
::itk::ExceptionObject e_(__FILE__, __LINE__, message.str(), ITK_LOCATION); \
throw e_; \
} \
}
#define otbUnusedMacro(x) \
do \
{ \
(void)sizeof(x); \
} while (0)
//
// Unused variable warnings in Debug/Release management.
// see http://stackoverflow.com/questions/2290509/debug-vs-ndebug#2290616
#ifdef OTB_DEBUG
#define otbUseInDebug(name) name
#define otbUseInRelease(name)
#else // NDEBUG
#define otbUseInDebug(name)
#define otbUseInRelease(name) name
#endif // NDEBUG
#endif // end of otbMacro.h
|
