freStatisticDictionary.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: freStatisticDictionary.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 __freStatisticDictionary_h
#define __freStatisticDictionary_h

#include "freElementals.h"

#include "freStatisticValueDefinition.h"
#include "freStatisticEntryDefinition.h"

#include "freXMLCollectionBase.h"

namespace FREE
{

freXMLTagMacro(StatisticDictionary, "freStat:Dictionary");
freXMLTagMacro(StatisticValueDefinitions, "freStat:ValueDefinitions");
freXMLTagMacro(StatisticEntryDefinitions, "freStat:EntryDefinitions");

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

        itkTypeMacro(StatisticDictionary, XMLStreamObject);
  itkNewMacro(StatisticDictionary);

  typedef StatisticValueDefinition::IDType ValueIDType;
  typedef StatisticEntryDefinition::IDType EntryIDType;
  typedef unsigned long IndexType;

  typedef XMLCollectionBase<StatisticValueDefinition> ValueDefinitionsType;
  typedef XMLCollectionBase<StatisticEntryDefinition> EntryDefinitionsType;

  StatisticValueDefinition* AddValueDefinition();
  StatisticValueDefinition* AddValueDefinition(const std::string& sIDPath,
                                               const std::string& sName,
                                               const std::string& sDescription);

  StatisticValueDefinition* GetValueDefinitionByName(const std::string& sIDPath, const std::string& sName);
  StatisticValueDefinition* GetValueDefinitionByIndex(const IndexType& index);
  StatisticValueDefinition* GetValueDefinitionByID(const ValueIDType& id);
  ValueIDType GetValueDefinitionIDByName(const std::string& sIDPath, const std::string& sName);

  StatisticEntryDefinition* AddEntryDefinition();
  StatisticEntryDefinition* AddEntryDefinition(const std::string& sIDPath,
                                               const std::string& sName, 
                                               const std::string& sControllerID,
                                               const std::string& sDescription);

  StatisticEntryDefinition* GetEntryDefinitionByName(const std::string& sIDPath, const std::string& sName);
  StatisticEntryDefinition* GetEntryDefinitionByIndex(const IndexType& index);
  StatisticEntryDefinition* GetEntryDefinitionByID(const EntryIDType& id);
  EntryIDType GetEntryDefinitionIDByName(const std::string& sIDPath, const std::string& sName);

  virtual ~StatisticDictionary();

  virtual void Reset();

protected:
  StatisticDictionary();

  ValueDefinitionsType m_ValueDefs;
  EntryDefinitionsType m_EntryDefs;

  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

---