otbWrapperParameter.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 otbWrapperParameter_h
#define otbWrapperParameter_h
 
 
#include "OTBApplicationEngineExport.h"
#include "otbMacro.h"
#include "otbWrapperTypes.h"
 
 
#include <itkObjectFactory.h>
 
 
#include <string>
 
 
namespace otb
{
namespace Wrapper
{
 
class OTBApplicationEngine_EXPORT Parameter : public itk::Object
{
public:
  typedef Parameter                     Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(Parameter, itk::Object);
 
  virtual void        SetName(const std::string&);
  virtual const char* GetName() const;
 
  virtual void               SetDescription(const std::string&);
  virtual const std::string& GetDescription() const;
 
  virtual void        SetKey(const std::string&);
  virtual const char* GetKey() const;
 
  virtual void SetActive(bool flag);
  bool GetActive(bool recurseParents = false) const;
 
  virtual void SetMandatory(bool flag);
  virtual bool GetMandatory() const;
  virtual void MandatoryOn();
  virtual void MandatoryOff();
 
  virtual void SetAutomaticValue(bool flag);
 
  virtual bool GetAutomaticValue() const;
 
  void AutomaticValueOn();
 
  void AutomaticValueOff();
 
  virtual void SetUserLevel(const UserLevel level);
 
  virtual UserLevel GetUserLevel() const;
 
  virtual void SetRole(const Role role);
 
  virtual Role GetRole() const;
 
  virtual void Reset();
 
  virtual bool HasValue() const = 0;
 
  virtual bool HasUserValue() const;
 
  virtual void SetUserValue(bool isUserValue);
 
  virtual void ClearValue();
 
  virtual void SetRoot(const Parameter::Pointer root);
 
  virtual const Parameter::Pointer GetRoot() const;
 
  virtual bool IsRoot() const;
 
  virtual void AddChild(Parameter::Pointer child);
 
 
  virtual std::vector<Parameter::Pointer> GetChildrenList();
 
  virtual ParameterType GetType() const = 0;
 
  [[noreturn]] void TypeError(const std::string& target_type) const;
 
  virtual int                      ToInt() const;
  virtual float                    ToFloat() const;
  virtual double                   ToDouble() const;
  virtual std::string              ToString() const;
  virtual std::vector<std::string> ToStringList() const;
 
  virtual void FromInt(int);
  virtual void FromFloat(float);
  virtual void FromDouble(double);
  virtual void FromString(const std::string&);
  virtual void FromStringList(const std::vector<std::string>&);
 
protected:
  Parameter();
 
  std::string m_Name;
 
  std::string m_Description;
 
  std::string m_Key;
 
  bool m_Mandatory;
 
  bool m_Active;
 
  bool m_UserValue;
 
  UserLevel m_UserLevel;
 
  Role m_Role;
 
  itk::WeakPointer<Parameter> m_Root;
 
  std::vector<Parameter::Pointer> m_ChildrenList;
 
private:
  Parameter(const Parameter&) = delete;
  void operator=(const Parameter&) = delete;
 
}; // End class Parameter
 
} // End namespace Wrapper
} // End namespace otb
 
#endif