freStatisticEntry.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: freStatisticEntry.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 __freStatisticEntry_h
#define __freStatisticEntry_h

#include "freTimeStampedObject.h"
#include "freStatisticValue.h"
#include "freStatisticEntryDefinition.h"

#include "itkLightObject.h"

namespace FREE
{
freXMLTagMacro(StatisticEntry, "freStat:Entry");
freXMLTagMacro(StatisticEntryRef, "freStat:RefID");
freXMLTagMacro(StatisticEntryID, "freStat:ID");

/* Forward declaration*/
class StatisticData;

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

  typedef unsigned long IDType;
  static const IDType cUndefinedID;

  itkTypeMacro(StatisticEntry, TimeStampedObject);

  static Pointer New(const IDType& id, clock_t& stampOffset, StatisticData* pData)
  {
    Pointer smartPtr = new StatisticEntry(id, stampOffset, pData);
    smartPtr->UnRegister();

    return smartPtr;
  }

  typedef StatisticEntryDefinition::IDType ReferenceIDType;
  static const ReferenceIDType cUndefinedRef;

  typedef std::vector<StatisticValue> ValuesType;
  typedef std::vector<Pointer> EntriesType;

  StatisticEntry& operator = (const StatisticEntry& entry);

  StatisticEntry::Pointer CreateChildEntry();
  StatisticEntry::Pointer PostCreateChildEntry();

  void CloseEntry();

  virtual ~StatisticEntry();

  virtual void Reset();

  void SetID (const IDType& id) {m_ID = id;};
  IDType GetID () const { return m_ID; };

  void SetRefID (const ReferenceIDType& id) {m_RefID = id;};
  ReferenceIDType GetRefID () const { return m_RefID; };

  const ValuesType& GetValues() const {return m_Values;};
  ValuesType& GetValues() {return m_Values;};

  const EntriesType& GetEntries() const {return m_Entries;};
  EntriesType& GetEntries() {return m_Entries;};

  StatisticValue& AddValue(const std::string& sValue, const StatisticValue::ReferenceIDType& refID);

protected:
  StatisticEntry(const IDType& id, clock_t& stampOffset, StatisticData* pData);

  IDType m_ID;

  ReferenceIDType m_RefID;

  StatisticData* m_pData;

  ValuesType m_Values;

  EntriesType m_Entries;

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

} //end of namespace FREE

#endif

---