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
|
/*
* 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.
*/
#ifndef otbWrapperParameterKey_h
#define otbWrapperParameterKey_h
#include <string>
#include <vector>
#include <ostream>
#include <itksys/RegularExpression.hxx>
#include "itkMacro.h"
#include "OTBApplicationEngineExport.h"
namespace otb
{
namespace Wrapper
{
/** \class Application
* \brief This class is a the Parameter key representation.
*
* The constructor accepts a string key constructed as follow : parent.me.child.
* It implements some key manipulation as described in the code.
*
* \ingroup OTBApplicationEngine
*/
class OTBApplicationEngine_EXPORT ParameterKey
{
public:
typedef ParameterKey Self;
ParameterKey();
ParameterKey(const char* val);
ParameterKey(const std::string& val);
virtual ~ParameterKey();
/** Class Methods used to interface with the registered factories */
/*
last() : return "tata"
** parent() : return "toto.titi"
** root() : return "toto"
** split() : return vector<string> ("toto", "titi", "tata")
** append(std::string)
** append(const Key&)
*/
/** Returns the string after the last point separator */
std::string GetLastElement();
/** Returns the string before the first point separator */
std::string GetFirstElement();
/** Returns the string before the last point separator */
std::string GetRoot();
/** Returns the vector of string that contains each element separated by a point. */
std::vector<std::string> Split();
/** Append a string at the end of the key. A point separator will be added before the string. */
void Append(const std::string& val);
/** Append a string at the end of the key. A point separator will be added before the string. */
void Append(const ParameterKey& pKey);
/** Get Key value */
std::string GetKey()
{
return m_Key;
}
/** Get Key value */
std::string GetKey() const
{
return m_Key;
}
/** Set Key value */
void SetKey(const std::string& val)
{
// Check chain : lowercase, alphanumerical or "."
itksys::RegularExpression reg;
reg.compile("([^0-9a-z\\.])");
if (!reg.find(val))
{
m_Key = val;
}
else
{
itkGenericExceptionMacro("Invalid key '" << val << "'. Must be in lowercase, containing alphanumerical characters or \".\"");
}
}
private:
ParameterKey(const Self&) = delete;
void operator=(const Self&) = delete;
std::string m_Key;
};
} // end namespace Wrapper
} // end namespace otb
#endif // otbWrapperParameterKey_h_
|
