otbWrapperRAMParameter.h 3.38 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * Copyright (C) 2005-2017 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.
 */
Otmane Lahlou's avatar
Otmane Lahlou committed
20

21 22
#ifndef otbWrapperRAMParameter_h
#define otbWrapperRAMParameter_h
Otmane Lahlou's avatar
Otmane Lahlou committed
23 24 25 26 27 28 29 30 31 32

#include "otbWrapperNumericalParameter.h"

namespace otb
{
namespace Wrapper
{

/** \class RAMParameter
 *  \brief This class represent a RAM parameter for the wrapper framework
33 34
 *
 * \ingroup OTBApplicationEngine
Otmane Lahlou's avatar
Otmane Lahlou committed
35
 */
36
class OTBApplicationEngine_EXPORT RAMParameter : public Parameter
Otmane Lahlou's avatar
Otmane Lahlou committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
{
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;
54

55
  bool HasValue() const override
Otmane Lahlou's avatar
Otmane Lahlou committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  {
    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
74
  void ClearValue() override
Otmane Lahlou's avatar
Otmane Lahlou committed
75 76 77 78 79
  {
    m_UnsignedIntParam->ClearValue();
  }

  // Reset
80
  void Reset() override
Otmane Lahlou's avatar
Otmane Lahlou committed
81 82 83 84
  {
    m_UnsignedIntParam->Reset();
  }

85
  // Reimplement the SetActive method
86
  void SetActive( bool value ) override
87 88 89 90 91 92 93
  {
    Superclass::SetActive( value );
    m_UnsignedIntParam->SetActive( value );
  }

  otbGetObjectMemberConstMacro(UnsignedIntParam, Active, bool);

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

Otmane Lahlou's avatar
Otmane Lahlou committed
102 103
    // Initialize the unsigned int NumericalParam
    m_UnsignedIntParam = UnsignedIntParameter::New();
104 105 106

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

  /** Destructor */
110
  ~RAMParameter() override
Otmane Lahlou's avatar
Otmane Lahlou committed
111 112 113
  {}

private:
114 115
  RAMParameter(const RAMParameter &) = delete;
  void operator =(const RAMParameter&) = delete;
Otmane Lahlou's avatar
Otmane Lahlou committed
116 117 118 119 120 121 122 123

  UnsignedIntParameter::Pointer         m_UnsignedIntParam;
};

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

#endif