freESStrategicParameter.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freESStrategicParameter.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  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 __freESStrategicParameter_h
#define __freESStrategicParameter_h

#include "itkLightObject.h"

namespace FREE
{

  namespace ES
  {
    template <class TValueType>
    class ITK_EXPORT StrategicParameter :
      public itk::LightObject
    {
    public:
      /* Standard class typedefs. */
      typedef StrategicParameter<TValueType> Self;
      typedef itk::LightObject Superclass;
      typedef itk::SmartPointer<Self> Pointer;
      typedef itk::SmartPointer<const Self> ConstPointer;

      /* Method for creation through the object factory. */
      itkNewMacro(Self);

      /* Run-time type information (and related methods). */
      itkTypeMacro(StrategicParameter, LightObject);

      /* Other typedefs */
      typedef TValueType ParameterValueType;
      typedef std::string OriginIDType;

      enum HandlingType
      { 
        HStatic, //* Parameter should not be changed by recombination or mutation
        HDynamic //* Parameter can be changed by recombination or mutation
      };

      bool operator == (const ParameterValueType& value) const {return value==m_Value;};

      void operator = (const ParameterValueType& value) {m_Value = value;};
      void operator = (const Self& parameter);

      operator ParameterValueType () const {return m_Value;};
      operator ParameterValueType& () {return m_Value;};

      ParameterValueType& GetValue() {return m_Value;};
      const ParameterValueType& GetValue() const {return m_Value;};
      void SetValue(const ParameterValueType& value) { m_Value = value;};

      const OriginIDType& GetOrigin() const {return m_Origin;};
      void SetOrigin(const OriginIDType& origin) { m_Origin = origin;};

      const HandlingType& GetHandling() const {return m_Handling;};
      void SetHandling(const HandlingType& handling) { m_Handling = handling;};

      Pointer Clone() const;

    protected:
      ParameterValueType m_Value;
      OriginIDType m_Origin;
      HandlingType m_Handling;

      StrategicParameter(){}
      virtual ~StrategicParameter(){}

    private:
      StrategicParameter(Self const&); // Purposely not implemented.
    };

  } //end namspsace ES
} // end namespace FREE

#ifndef ITK_MANUAL_INSTANTIATION
#include "freESStrategicParameter.txx"
#endif

#endif // __freESStrategicParameter_h

---