freXMLValueSet.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: freXMLValueSet.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 __freXMLValueSet_h
#define __freXMLValueSet_h

#include "freElementals.h"
#include "freXMLStreamObject.h"
#include "freExceptions.h"
#include "freConvert.h"

namespace FREE
{

class XMLValueSet: public XMLStreamObject
{
public:
  typedef STLStringVector ValuesType;
  typedef unsigned long ValueCountType;

  void Reset(const ValueCountType iValueCount, const std::string& sNewValue = "");

  virtual void Reset();

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

  ValueCountType Size() const;

  bool GetValue(bool& value, ValueCountType iItemPos = 0) const;

  bool GetValue(float& value, ValueCountType iItemPos = 0) const;

  bool GetValue(double& value, ValueCountType iItemPos = 0) const;
  
  bool GetValue(unsigned int& value, ValueCountType iItemPos = 0) const;

  bool GetValue(int& value, ValueCountType iItemPos = 0) const;

  bool GetValue(long& value, ValueCountType iItemPos = 0) const;

  bool GetValue(unsigned long& value, ValueCountType iItemPos = 0) const;

  bool GetValue(std::string& value, ValueCountType iItemPos = 0) const;

  bool SetValue(const bool value, ValueCountType iItemPos = 0);

  bool SetValue(const double value, ValueCountType iItemPos = 0);
  
  bool SetValue(const float value, ValueCountType iItemPos = 0);

  bool SetValue(const int value, ValueCountType iItemPos = 0);

  bool SetValue(const unsigned int value, ValueCountType iItemPos = 0);

  bool SetValue(const long value, ValueCountType iItemPos = 0);

  bool SetValue(const unsigned long value, ValueCountType iItemPos = 0);

  bool SetValue(const std::string& value, ValueCountType iItemPos = 0);

  virtual XMLValueSet& operator = (const XMLValueSet& valueSet);

  XMLValueSet(const ValueCountType iValueCount, const std::string& sNewValue = "");

  XMLValueSet();

  XMLValueSet( const XMLValueSet& valueSet);

  virtual ~XMLValueSet();

protected:
  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;

  ValuesType m_Values;
};

namespace Convert
{

        template <typename TFixedArray> static void ITKFixedArrayToValueSet(const TFixedArray& rArray, ::FREE::XMLValueSet& rSet)
  {
        rSet.Resize(rArray.Size());
          for (unsigned int iDim=0; iDim<rArray.Size(); iDim++)
    {
                  rSet.SetValue(rArray.GetElement(iDim),iDim);
    };
  };

  template <typename TIndex> static void ITKIndexToValueSet(const TIndex& rIndex, ::FREE::XMLValueSet& rSet)
  {
    rSet.Resize(TIndex::GetIndexDimension());
          for (unsigned int iDim=0; iDim<rSet.Size(); iDim++)
    {
                  rSet.SetValue(rIndex.GetElement(iDim),iDim);
    };
  };

  template <typename TSize>     static void ITKSizeToValueSet(const TSize& rSize, ::FREE::XMLValueSet& rSet)
  {
    rSet.Resize(TSize::GetSizeDimension());
          for (unsigned int iDim=0; iDim<rSet.Size(); iDim++)
    {
                  rSet.SetValue(rSize.GetElement(iDim),iDim);
    };
  };

        template <typename TArray>      static void ITKArrayToValueSet(const TArray& rArray, ::FREE::XMLValueSet& rSet)
  {
    ITKFixedArrayToValueSet(rArray,rSet);
  };

  template <typename TFixedArray>       static ::FREE::XMLValueSet ITKFixedArrayToValueSet(const TFixedArray& rArray)
  {
    XMLValueSet values;
    ITKFixedArrayToValueSet(rArray,values);
    return values;
  };

        template <typename TIndex> static ::FREE::XMLValueSet ITKIndexToValueSet(const TIndex& rIndex)
  {
    XMLValueSet values;
    ITKIndexToValueSet(rIndex,values);
    return values;
  };

        template <typename TSize>       static ::FREE::XMLValueSet ITKSizeToValueSet(const TSize& rSize)
  {
    XMLValueSet values;
    ITKSizeToValueSet(rSize,values);
    return values;
  };
        
        template <typename TArray>      static ::FREE::XMLValueSet ITKArrayToValueSet(const TArray& rArray)
  {
    return ITKFixedArrayToValueSet(rArray);
  };

        template <typename TFixedArray> static TFixedArray ValueSetToITKFixedArray(const ::FREE::XMLValueSet& rSet)
  {
    TFixedArray newArray;
                if (newArray.Size()!=rSet.Size())
                   throwStaticExceptionMacro("Dimension of fixed array and size of parameter layer differ. Fixed array dim: " << Convert::ToStr(newArray.Size()) << "; layer dim: " << Convert::ToStr(rSet.Size()));

    typename TFixedArray::ValueType value;
                for (int i=0; i<newArray.Size(); i++)
    {
      rSet.GetValue(value,i);
      newArray[i]=value;
    }
                return newArray;
  };

        template <typename TIndex> static TIndex ValueSetToITKIndex(const ::FREE::XMLValueSet& rSet)
  {
    TIndex newIndex;
    if (rSet.Size()!=TIndex::GetIndexDimension()) throwStaticExceptionMacro("Dimension of index and size of parameter layer differ. Index dim: " << TIndex::GetIndexDimension() << "; layer dim: " << Convert::ToStr(rSet.Size()));

    typename TIndex::IndexValueType value;
                for (int i=0; i<rSet.Size(); i++)
    {
      rSet.GetValue(value,i);
      newIndex.SetElement(i,value);
    }
                return newIndex;
  };

        template <typename TSize>       static TSize ValueSetToITKSize(const ::FREE::XMLValueSet& rSet)
  {
    TSize newSize;
    if (rSet.Size()!=TSize::GetSizeDimension()) throwStaticExceptionMacro("Dimension of itk::Size and size of parameter layer differ. Size dim: " << TSize::GetSizeDimension() << "; layer dim: " << Convert::ToStr(rSet.Size()));

    typename TSize::SizeValueType value;
                for (int i=0; i<rSet.Size(); i++)
    {
      rSet.GetValue(value,i);
      newSize.SetElement(i,value);
    }
                return newSize;
  };

        template <typename TArray>      static TArray ValueSetToITKArray(const ::FREE::XMLValueSet& rSet)
  {
    TArray newArray(rSet.Size());

    typename TArray::ValueType value;
                for (int i=0; i<newArray.Size(); i++)
    {
      rSet.GetValue(value,i);
      newArray[i]=value;
    }
                return newArray;
  };
}//end of namespace Convert
}//end of namespace FREE

#endif

---