freParameter.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: freParameter.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 __freParameter_h
#define __freParameter_h

#include "freParameterLayer.h"
#include "freExceptions.h"

namespace FREE
{
  class Parameter: public XMLStreamObject, public itk::LightObject
{
public:
  typedef Parameter  Self;
  typedef itk::LightObject Superclass;
  typedef itk::SmartPointer<Self>        Pointer;
  typedef itk::SmartPointer<const Self>  ConstPointer;
  

  enum ParameterValueType 
  {
          PVTBool, 
          PVTDouble, 
          PVTInteger, 
          PVTLong, 
          PVTULong, 
          PVTString, 
          PVTURI, 
          PVTIDPath 
  };

  typedef ParameterLayer::ValueCountType ValueCountType;
  typedef unsigned long LayerCountType;

  itkTypeMacro( Parameter, XMLStreamObject );

  itkNewMacro(Parameter);
  static Pointer New(const std::string& sParameterName, const ValueCountType iLayerSize = 1, const LayerCountType iLayerCount = 1, const std::string& sDefaultValue = "");

  void SetParameterName(const std::string& sName) {m_sParameterName = sName; };
  const std::string& GetParameterName() const { return m_sParameterName; };

  void SetTemplateID(const std::string& sTemplateID) {m_sTemplateID = sTemplateID; };
  const std::string& GetTemplateID() const { return m_sTemplateID; };
  bool IsTemplateBased() const {return m_sTemplateID.size()>0;};

  LayerCountType AddParameterLayer(bool bCopyValue = true, const std::string& sNewValue = "");

  void DeleteParameterLayer(const LayerCountType iLayer);

  virtual void Reset();

  void Resize(const ValueCountType iNewSize, const std::string& sNewValue = "");

  void Resize(const ValueCountType iNewSize, const LayerCountType iNewLayerCount, const std::string& sNewValue = "");

  ValueCountType ParameterSize() const;

  LayerCountType LayerCount() const;

  ParameterLayer* GetParameterLayer(const LayerCountType iLayer) const;

  bool GetParameterValue(bool& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0) const;

  bool GetParameterValue(double& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0) const;
  
  bool GetParameterValue(int& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0) const;

  bool GetParameterValue(long& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0) const;

  bool GetParameterValue(unsigned long& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0) const;

  bool GetParameterValue(std::string& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0) const;

  bool SetParameterValue(const bool value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0);

  bool SetParameterValue(const double value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0);
  
  bool SetParameterValue(const int value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0);

  bool SetParameterValue(const long value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0);

  bool SetParameterValue(const unsigned long value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0);

  bool SetParameterValue(const std::string& value, const  ValueCountType iItemPos = 0, const LayerCountType iLayer = 0);

  bool SetParameterLayer(const LayerCountType iLayer, const ParameterLayer& rSourceLayer);

  virtual Parameter& operator = (const Parameter& rParameter);

protected:
  Parameter(const std::string& sParameterName, const ValueCountType iLayerSize = 1, const LayerCountType iLayerCount = 1, const std::string& sDefaultValue = "");
  Parameter();

  virtual ~Parameter();

  virtual void SubElementLoadProcessing(const std::string& rsXMLSubTag, const std::string& rsXMLSubElement, const std::string& rsXMLSubData);

  virtual std::string SaveData(const unsigned int& iDepth, bool& bHasSubElements) const;

  virtual void AttributesLoadProcessing(const AttributesType& rAttributes);

  virtual void SaveAttributes(AttributesSaveListType& rAttributes) const;

  typedef std::vector<ParameterLayer::Pointer> LayersType; 
  
  LayersType m_Layers;

  std::string m_sParameterName;

  std::string m_sTemplateID;

  LayerCountType m_iLayerSize;
};

namespace Convert
{
  std::string ToStr(const Parameter::ParameterValueType& pt);
  Parameter::ParameterValueType ToParameterValueType(const std::string& sValue);
}

}//end of namespace FREE

#endif

---