otbWrapperChoiceParameter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbWrapperChoiceParameter_h
#define __otbWrapperChoiceParameter_h

#include "otbWrapperParameter.h"
#include "otbWrapperParameterGroup.h"

namespace otb
{
namespace Wrapper
{

class 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 );

  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();

  bool HasValue() const
  {
    // a choice parameter always has a value
    return true;
  }

  void ClearValue()
  {
    // nothing to do : a choice parameter always has a value
  }

protected:
  ChoiceParameter();

  virtual ~ChoiceParameter();

  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 &); //purposely not implemented
  void operator =(const ChoiceParameter&); //purposely not implemented

}; // End class Parameter

} // End namespace Wrapper
} // End namespace otb

#endif