otbWrapperChoiceParameter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 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 otbWrapperChoiceParameter_h
#define otbWrapperChoiceParameter_h
 
#include "otbWrapperParameterGroup.h"
#include <string>
 
namespace otb
{
namespace Wrapper
{
 
class OTBApplicationEngine_EXPORT ChoiceParameter : public Parameter
{
public:
  typedef ChoiceParameter               Self;
  typedef Parameter                     Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ChoiceParameter, Parameter);
 
  void AddChoice(std::string choicekey, std::string choiceName);
 
  std::string GetChoiceKey(int i) const;
 
  std::vector<std::string> GetChoiceKeys();
 
  std::string GetChoiceName(int i);
 
  std::vector<std::string> GetChoiceNames();
 
  ParameterGroup::Pointer GetChoiceParameterGroupByIndex(int i);
 
  ParameterGroup::Pointer GetChoiceParameterGroupByKey(std::string choiceKey);
 
  std::vector<std::string> GetParametersKeys();
 
  unsigned int GetNbChoices(void);
 
  virtual void SetValue(unsigned int v);
 
  virtual void SetValue(std::string choiceKey);
 
  virtual unsigned int GetValue() const;
 
  bool HasValue() const override;
  void ClearValue() override;
 
  ParameterType GetType() const override;
 
  int  ToInt() const override;
  void FromInt(int value) override;
 
  std::string ToString() const override;
  void FromString(const std::string& value) override;
 
protected:
  ChoiceParameter();
 
  ~ChoiceParameter() 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&) = delete;
  void operator=(const ChoiceParameter&) = delete;
 
}; // End class Parameter
 
} // End namespace Wrapper
} // End namespace otb
 
#endif