freParameterCollection.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: freParameterCollection.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 __freParameterCollection_h
#define __freParameterCollection_h

#include "freParameter.h"
#include "freIDPath.h"

namespace FREE
{

class ParameterCollection: public FREE::XMLStreamObject
{
public:
  typedef Parameter::Pointer ParameterPointer;
  typedef std::vector<ParameterPointer> ParametersType; 

  typedef ParameterLayer::ValueCountType ValueCountType;
  typedef Parameter::LayerCountType LayerCountType;
  typedef ParametersType::size_type ParameterCountType;

  Parameter* AddParameter(const std::string& sParameterName, const ValueCountType iLayerSize =1, const LayerCountType iLayerCount =1);

  void DeleteParameter(const std::string& sParameterName);

  void DeleteParameter(const ParameterCountType index);

  void AddParameterLayer(const std::string& sParameterName, bool bCopyValue = true);

  void DeleteParameterLayer(const std::string& sParameterName, const LayerCountType iLayer);

  virtual void ResetParameters();

  virtual void Reset();

  bool ParameterExists(const std::string& sParameterName) const;

  ParameterCountType Size() const;

  ValueCountType ParameterSize(const std::string& sParameterName) const;

  LayerCountType ParameterLayerCount(const std::string& sParameterName) const;

  ParameterCountType GetParameterIndex(const std::string& sParameterName) const;

  std::string GetParameterName(const ParameterCountType& index) const;

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

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

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

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

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

  bool GetParameterValueByIDPath(const IDPath& parameterID, std::string& value) const;

  bool GetParameterValueByIDPath(const IDPath& parameterID, bool& value) const;

  bool GetParameterValueByIDPath(const IDPath& parameterID, double& value) const;
  
  bool GetParameterValueByIDPath(const IDPath& parameterID, int& value) const;

  bool GetParameterValueByIDPath(const IDPath& parameterID, long& value) const;

  bool GetParameterValueByIDPath(const IDPath& parameterID, unsigned long& value) const;

  bool GetParameterDataString(const std::string& sParameterName, std::string& sData) const;

  Parameter* GetParameter(const std::string& sParameterName) const;

  Parameter* GetParameter(ParameterCountType index) const;

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

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

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

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

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

  bool SetParameterValueByIDPath(const IDPath& parameterID, std::string& value);

  bool SetParameterValueByIDPath(const IDPath& parameterID, bool& value);

  bool SetParameterValueByIDPath(const IDPath& parameterID, double& value);
  
  bool SetParameterValueByIDPath(const IDPath& parameterID, int& value);

  bool SetParameterValueByIDPath(const IDPath& parameterID, long& value);

  bool SetParameterValueByIDPath(const IDPath& parameterID, unsigned long& value);

  virtual ParameterCollection& operator = (const ParameterCollection& rParameterCollection);

  ParameterCollection();

  ParameterCollection( const ParameterCollection& rParameterCollection);

  virtual ~ParameterCollection();

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;

  ParametersType m_Parameters;
};

}//end of namespace FREE

#endif

---