TimeStamp.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2015.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWCORE_TIMESTAMP_HPP__
#define __FWCORE_TIMESTAMP_HPP__

#include "fwCore/base.hpp"
#include "fwCore/HiResClock.hpp"

namespace fwCore
{

class FWCORE_CLASS_API TimeStamp : public BaseObject
{

public:
    fwCoreClassDefinitionsWithFactoryMacro( (TimeStamp)(BaseObject), (()), new TimeStamp);

    typedef ::fwCore::HiResClock::HiResClockType TimeStampType;



    FWCORE_API TimeStamp()
    {
        this->m_modifiedTime = 0;
        this->m_lifePeriod   = 0;
    }

    FWCORE_API void modified();


    FWCORE_API TimeStampType getTimeStamp() const
    {
        return this->m_modifiedTime;
    }



    FWCORE_API bool operator>(const TimeStamp& ts) const
    {
        return ( this->m_modifiedTime > ts.m_modifiedTime );
    }

    FWCORE_API bool operator<(const TimeStamp& ts) const
    {
        return ( this->m_modifiedTime < ts.m_modifiedTime );
    }

    FWCORE_API operator TimeStampType() const
    {
        return this->m_modifiedTime;
    }


    FWCORE_API void setLifePeriod(TimeStampType period)
    {
        m_lifePeriod = period;
    }

    FWCORE_API TimeStampType getLifePeriod() const
    {
        return m_lifePeriod;
    }


    FWCORE_API bool periodExpired() const
    {
        return (::fwCore::HiResClock::getTimeInMilliSec() - this->m_modifiedTime) > m_lifePeriod;
    }


private:
    TimeStampType m_modifiedTime;

    TimeStampType m_lifePeriod;

};


} //namespace fwCore

#endif // __FWCORE_TIMESTAMP_HPP__