freStatisticValueDefinition.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: freStatisticValueDefinition.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 __freStatisticValueDefinition_h
#define __freStatisticValueDefinition_h

#include "freElementals.h"
#include "freXMLStreamObject.h"

namespace FREE
{

freXMLTagMacro(StatisticValueReference, "freStat:RefID");
freXMLTagMacro(StatisticValueDefinition, "freStat:ValueDefinition");
freXMLTagMacro(StatisticValueDefName, "freStat:Name");
freXMLTagMacro(StatisticValueDefType, "freStat:Type");
freXMLTagMacro(StatisticValueDefDescription, "freStat:Description");
freXMLTagMacro(StatisticValueDefIDPath, "freStat:ComponentIDPath");

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

        itkTypeMacro(StatisticValueDefinition, XMLStreamObject);
  itkNewMacro(StatisticValueDefinition);

  typedef unsigned long IDType;
  
  virtual void Reset();

  void SetName(const std::string& sName)
  {m_sName = sName;};

  const std::string& GetName() const
  {return m_sName;};

  void SetIDPath(const std::string& sIDPath)
  {m_sIDPath = sIDPath;};

  const std::string& GetIDPath() const
  {return m_sIDPath;};

  void SetDescription(const std::string& sDescription)
  {m_sDescription = sDescription;};

  const std::string& GetDescription() const
  {return m_sDescription;};

  void SetType(const std::string& sType)
  {m_sType = sType;};

  const std::string& GetType() const
  {return m_sType;};

  void SetRefID(const IDType& id)
  {m_RefID = id;};

  const IDType& GetRefID() const
  {return m_RefID;};

  virtual StatisticValueDefinition& operator = (const StatisticValueDefinition& rEntry);

protected:
  std::string m_sName;
  std::string m_sIDPath;
  std::string m_sDescription;
  std::string m_sType;
  IDType m_RefID;

  StatisticValueDefinition();
  virtual ~StatisticValueDefinition();

  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;
};

} //end of namespace FREE

#endif

---