freTimeStampedObject.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: freTimeStampedObject.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 __freTimeStampedObject_h
#define __freTimeStampedObject_h

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

#include <time.h>

namespace FREE
{

/* Type represents the duration of a time span (e.g. registration step) in tenth seconds*/
typedef long DurationType;
typedef long TimeStampType; //will be scaled in tenth seconds;

freXMLTagMacro(TimeStamp, "freStat:TimeStamp");
freXMLTagMacro(TimeStampCreate, "freStat:TSCreate");
freXMLTagMacro(TimeStampClose, "freStat:TSClose");

class TimeStampedObject: public XMLStreamObject
{
public:
  DurationType GetDurationTo(const TimeStampedObject& object) const;
  DurationType GetInterimDurationTo(const TimeStampedObject& object) const;
  DurationType GetDuration() const;

  TimeStampedObject& operator = (const TimeStampedObject& object);

  TimeStampedObject(clock_t& stampOffset, const std::string& sXMLTag = XMLTags::TimeStamp);

  TimeStampedObject(const TimeStampedObject& object);

  virtual ~TimeStampedObject();

  const TimeStampType& GetCreationTimeStamp() const;
        const TimeStampType& GetClosingTimeStamp() const;

        inline void SetCreationTimeStamp()
        {
                Stamp(m_CreationTimeStamp,m_StampOffset);
        };
        inline void SetCreationTimeStamp(const TimeStampType& timeStamp)
        {
                m_CreationTimeStamp = timeStamp;
        };

        inline void SetClosingTimeStamp()
        {
                Stamp(m_ClosingTimeStamp,m_StampOffset);
        };
        inline void SetClosingTimeStamp(const TimeStampType& timeStamp)
        {
                m_ClosingTimeStamp = timeStamp;
        };

        /* Checks if the time stamp is already closed.*/
  const bool IsClosed() const;
        /* Checks if there is already a creation time stamp.*/
        const bool IsCreated() const;

  virtual void Reset();

protected:
  virtual void AttributesLoadProcessing(const AttributesType& rAttributes);

  virtual void SaveAttributes(AttributesSaveListType& rAttributes) const; 

  clock_t& GetStampOffset() const;

private:
  /* Functions sets the passed stamp*/
  static void Stamp(TimeStampType& rTimeStamp, clock_t& stampOffset);

  TimeStampType m_CreationTimeStamp;

  TimeStampType m_ClosingTimeStamp;

  clock_t& m_StampOffset;
};


} //end of namespace FREE

#endif

---