OTB  9.0.0
Orfeo Toolbox
otbWrapperStringListParameter.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
3  *
4  * This file is part of Orfeo Toolbox
5  *
6  * https://www.orfeo-toolbox.org/
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 
21 #ifndef otbWrapperStringListParameter_h
22 #define otbWrapperStringListParameter_h
23 
24 
27 
28 
29 namespace otb
30 {
31 
32 
33 namespace Wrapper
34 {
35 
41 class OTBApplicationEngine_EXPORT StringListParameter : public ParameterList<StringParameter>
42 {
43  //
44  // Public methods.
45 public:
49  typedef itk::SmartPointer<Self> Pointer;
50  typedef itk::SmartPointer<const Self> ConstPointer;
51 
53 
55  itkNewMacro(Self);
56 
58  itkTypeMacro(StringListParameter, ParameterList);
59 
61  void SetValue(const StringListInterface::StringVector&);
62 
64  void AddString(const std::string& value);
65 
67  StringListInterface::StringVector GetValue() const;
68 
70  std::string GetNthElement(std::size_t) const;
71 
73  void SetNthElement(std::size_t, const std::string&);
74 
77  Role GetDirection() const override;
78 
80  bool IsFilename() const override;
81 
82  ParameterType GetType() const override
83  {
85  }
86 
87  //
88  // Protected methods.
89 protected:
92 
94  ~StringListParameter() override;
95 
96  //
97  // Private methods.
98 private:
100 
101  void operator=(const StringListParameter&) = delete;
102 
103 }; // End class Parameter
104 
105 } // End namespace Wrapper
106 
107 } // End namespace otb
108 
109 #endif
otb::Wrapper::StringListParameter::StringListType
StringListInterface::StringVector StringListType
Definition: otbWrapperStringListParameter.h:52
otb::Wrapper::StringListParameter
This class represent a list of string parameter for the wrapper framework.
Definition: otbWrapperStringListParameter.h:41
otb::Wrapper::ParameterList
This class represents a InputImage parameter.
Definition: otbWrapperParameterList.h:42
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::Wrapper::StringListInterface::GetDirection
virtual Role GetDirection() const =0
otbWrapperParameterList.h
otb::Wrapper::StringListParameter::Self
StringListParameter Self
Definition: otbWrapperStringListParameter.h:47
otb::Wrapper::StringListParameter::GetType
ParameterType GetType() const override
Definition: otbWrapperStringListParameter.h:82
otbWrapperStringParameter.h
otb::Wrapper::Role
Role
Definition: otbWrapperTypes.h:126
otb::Wrapper::StringListParameter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbWrapperStringListParameter.h:50
otb::Wrapper::AbstractParameterList
This class is a base class for list-type parameters.
Definition: otbWrapperAbstractParameterList.h:41
otb::Wrapper::StringListInterface::StringVector
std::vector< std::string > StringVector
Definition: otbWrapperStringListInterface.h:48
otb::Wrapper::ParameterType_StringList
@ ParameterType_StringList
Definition: otbWrapperTypes.h:42
otb::Wrapper::StringListParameter::Superclass
ParameterList< StringParameter > Superclass
Definition: otbWrapperStringListParameter.h:48
otb::Wrapper::StringListParameter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWrapperStringListParameter.h:49
otb::Wrapper::ParameterType
ParameterType
Definition: otbWrapperTypes.h:37