otbWrapperRAMParameter.h 3.26 KB
Newer Older
Otmane Lahlou's avatar
Otmane Lahlou committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++


  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.

=========================================================================*/
16 17
#ifndef otbWrapperRAMParameter_h
#define otbWrapperRAMParameter_h
Otmane Lahlou's avatar
Otmane Lahlou committed
18 19 20 21 22 23 24 25 26 27

#include "otbWrapperNumericalParameter.h"

namespace otb
{
namespace Wrapper
{

/** \class RAMParameter
 *  \brief This class represent a RAM parameter for the wrapper framework
28 29
 *
 * \ingroup OTBApplicationEngine
Otmane Lahlou's avatar
Otmane Lahlou committed
30
 */
31
class OTBApplicationEngine_EXPORT RAMParameter : public Parameter
Otmane Lahlou's avatar
Otmane Lahlou committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
{
public:
  /** Standard class typedef */
  typedef RAMParameter                  Self;
  typedef Parameter                     Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;

  /** Defining ::New() static method */
  itkNewMacro(Self);

  /** RTTI support */
  itkTypeMacro(RAMParameter, Parameter);

  /** typedef */
  typedef NumericalParameter<unsigned int>     UnsignedIntParameter;
  typedef UnsignedIntParameter::ScalarType     ScalarType;
49

50
  bool HasValue() const ITK_OVERRIDE
Otmane Lahlou's avatar
Otmane Lahlou committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
  {
    return m_UnsignedIntParam->HasValue();
  }

  // Set/Get Value
  otbSetObjectMemberMacro(UnsignedIntParam, Value , ScalarType);
  otbSetObjectMemberMacro(UnsignedIntParam, Value , std::string);
  otbGetObjectMemberMacro(UnsignedIntParam, Value , ScalarType);

  // Set/Get extremums
  otbSetObjectMemberMacro(UnsignedIntParam,  DefaultValue, ScalarType);
  otbGetObjectMemberMacro(UnsignedIntParam,  DefaultValue, ScalarType);
  otbSetObjectMemberMacro(UnsignedIntParam,  MinimumValue, ScalarType);
  otbGetObjectMemberMacro(UnsignedIntParam,  MinimumValue, ScalarType);
  otbSetObjectMemberMacro(UnsignedIntParam,  MaximumValue, ScalarType);
  otbGetObjectMemberMacro(UnsignedIntParam,  MaximumValue, ScalarType);

  // Clear Value
69
  void ClearValue() ITK_OVERRIDE
Otmane Lahlou's avatar
Otmane Lahlou committed
70 71 72 73 74
  {
    m_UnsignedIntParam->ClearValue();
  }

  // Reset
75
  void Reset() ITK_OVERRIDE
Otmane Lahlou's avatar
Otmane Lahlou committed
76 77 78 79
  {
    m_UnsignedIntParam->Reset();
  }

80
  // Reimplement the SetActive method
81
  void SetActive(  const bool value ) ITK_OVERRIDE
82 83 84 85 86 87 88
  {
    Superclass::SetActive( value );
    m_UnsignedIntParam->SetActive( value );
  }

  otbGetObjectMemberConstMacro(UnsignedIntParam, Active, bool);

Otmane Lahlou's avatar
Otmane Lahlou committed
89 90 91 92 93
protected:
  /** Constructor */
  RAMParameter()
  {
    this->SetName("RAM");
94
    this->SetDescription("Set the maximum of available memory for the pipeline execution in mega bytes (optional, 256 by default).");
95 96
    this->SetKey("ram");

Otmane Lahlou's avatar
Otmane Lahlou committed
97 98
    // Initialize the unsigned int NumericalParam
    m_UnsignedIntParam = UnsignedIntParameter::New();
99 100 101

    // 0 RAM is not allowed, make the minimum to 1 by default
    this->SetMinimumValue(1);
Otmane Lahlou's avatar
Otmane Lahlou committed
102 103 104
  }

  /** Destructor */
105
  ~RAMParameter() ITK_OVERRIDE
Otmane Lahlou's avatar
Otmane Lahlou committed
106 107 108 109 110 111 112 113 114 115 116 117 118
  {}

private:
  RAMParameter(const RAMParameter &); //purposely not implemented
  void operator =(const RAMParameter&); //purposely not implemented

  UnsignedIntParameter::Pointer         m_UnsignedIntParam;
};

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

#endif